icb4t.h

ICCP Toolkit 是在 Tru64下开发Tase.2通信协议的开发包

/*                                SPECTRUM: C                            txt off
 * Copyright (C) Siemens AG 1996 All Rights Reserved.Confidential
 * ICCP Block 4 type definitions
 *
 * $Id: icb4t.h,v 1.000.1.07 1997/09/19 21:34:56 nancyl Exp $
 *
 * $NewRev$
 * $NewRevEnd$
 *
 * $Log: icb4t.h,v $
 * Revision 1.000.1.07  1997/09/19  21:34:56  nancyl
 * Added missing header file include statement for ICCP merge into
 * Vienna base EMP13971
 *
 * Revision 1.000.1.06  1997/08/29  19:50:16  nancyl
 * Changes needed to allow ICCP code to be merged into Vienna base
 * EMP13971
 *
 * Revision 1.000.1.05  1997/08/07  18:51:14  rwoodruf
 * Change infoReqSize field type to LONG. EMP12638
 *
 * Revision 1.000.1.04  1997/06/26  12:42:35  rwoodruf
 * Add infoReqSize field to icMsgVariable to keep size of block 4
 * message to be ssent. EMP12638
 *
 * Revision 1.000.1.03  1997/04/18  22:01:10  shri
 * Multi-threading changes & SISCO recomended changes EMP12885
 *
 * Revision 1.000.1.02  1996/09/10  23:45:46  kevinr
 *  EMP10251
 * Moved this file from def_c directory to iccp/icapi.  Also
 * added prototypes of blk 4 functions.
 *
 * Revision 1.000.1.01  1996/04/12  17:08:29  bjmao
 * Correct Block 4 IMTransferSet type, and Info Buffer
 * variable name and type name. EMP7684
 *
 * Revision 1.000.1.00  1996/03/07  13:40:06  bjmao
 * -- revision created by srcinit -- EMP7086
 *
 * Revision 1.000  1996/03/07  13:40:06  bjmao
 * Initial revision EMP7086
 *
 * $Logend$
 *                                                                       txt on-
 */                                                                      /*-*/

#ifndef _ICB4T_H
#define _ICB4T_H

/* FILE START
************************************************************************

NAME
   icb4t.h  - include file for Block 4 

************************************************************************
*/

#ifndef ICAPI

#if SPEC_SUBSYSTEM_TREE
#include <base/syxscan_c.h>
#include <comms/DEF/icapi.h>
#else  /* SPEC_SUBSYSTEM_TREE */
#include <def_c/icapi.h>
#endif /* SPEC_SUBSYSTEM_TREE */

#else /* ICAPI */

#include "icapi.h"

#endif /* ICAPI */


/*
 * User Message Object Types
 */

#define PT_B4_FIRST            IC_B4_TYPE_MIN
#define PT_INFO_MESSAGE        IC_TYPE_INFO_BUF_HDR
#define PT_INFO_BUF            (1 + PT_INFO_MESSAGE)

#define BLK4PREFIX      "INFO"

/*
 * Additional Message Object Types
 */
#define PT_IM_TRANSFER_SET      (1 + PT_INFO_BUF)  /* IMTransferSet */

#define PT_B4_LAST             PT_IM_TRANSFER_SET

/* 
 * Information Message TransferSet Definition
 */

#define PT_IM_TRANSFER_SET_NAME  "IMTransferSet"
#define PT_IM_TRANSFER_SET_TDL   "Bool"

typedef icBoolean icTypeIMTransferSet;


#if 0  /* the following was version 5.2 */
#define PT_IM_TRANSFER_SET_TDL   "{(BlockData)Bool,(Status)Bool}"

typedef struct _ictypeimtransferset
{
    icBoolean                   BlockData;      /* TRUE (non 0), FALSE (0)   */
    icBoolean                   Status;         /* ENABLED (1), DISABLED (0) */
} icTypeIMTransferSet;
#endif


typedef struct _icmsgvariable             /* type = PT_INFO_BUF */
{
    /* -- Information created and maintained by API -- */
    icShort        Ctype ; /* 'C'ommon type field used in iccp.c */
    /* -- Information passed in by user application -- */
    icChar        *variableName; /* this must follow 'Ctype' ! */
    icInt          infoRefNum;
    icInt          variableScope;
    icInt          variableType;
    icTypeId       typeId;
    icInt          maxMsgSize;
    ST_LONG        infoReqSize;
    icUserData     userData;
    icRemoteId     remoteId ;
    void          *varValuePtr;  /* address of storage for header value */
    icInfoMsgRcvProcType    msgReceive;   /* Call after receives info report */
    icReqInfoMsgProcType    reqInfoMsg;   /* Call after rcvs IMConditions req*/
    struct icMsgVariable *next ;          /* ptr to next variable in chain */
} icMsgVariable;

typedef struct _icmsgtypaid_ {
    icInt                type;
    icTypeId             typeId;
    struct icMsgTypeId   *next ; /* ptr to next variable in chain */
}  icMsgTypeId ;

typedef icMsgTypeId *icMsgTypeIdPtr;


/* 
 * Block 4 Variable Name
 */

#define VA_IM_TRANSFER_SET_NAME    "IM_Transfer_Set"
#define VA_INFO_BUF_HDR_NAME       "Info_Mess_Header"

#define VA_INFO_BUF_NAME        "Info_Buff_"
#define PT_INFO_BUF_NAME        "InfoBuff"


#if 0  /* the following was version 5.2 */
#define VA_INFO_BUF_HDR_NAME       "Information_Message_Header"
/*  
 * the following is defined in icapi.h
 *
#define IC_TYPE_INFO_BUF_HDR_NAME  "InformationMessageHeader"
 */

#define VA_INFO_BUF_NAME        "Info_Stream_"
#define PT_INFO_BUF_NAME        "InfoBuf_"
#endif

/* Block 4 prototype functions */
icMsgTypeIdPtr  icGetMsgArrayTypeId ( icInt   arraySize);

icMsgTypeIdPtr  icGetMsgTypeId ( icInt   msgSize);


#endif /* _ICB4T_H */