icsdkt.h

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

    data_DiscreteType      Value;         /* point value       */
    data_TimeStampType     TimeStamp;     /* time stamp        */
    data_FlagType          Flags;         /* quality code      */
    data_CovCounterType    COVCount;      /* COV Counter       */
} ldDataDiscreteQExtType;

/*
 *
 * ICCP Real Point Type
 *
 */

typedef struct ldDataRealType             /* type = PT_DATA_REAL */
{
    data_RealType          Value;         /* point value       */
} ldDataRealType;

typedef struct ldDataRealQType            /* type = PT_DATA_REALQ */
{
    data_RealType          Value;         /* point value       */
    data_FlagType          Flags;         /* quality code      */
} ldDataRealQType;

typedef struct ldDataRealQTimeTagType /* type = PT_DATA_REALQ_TIMETAG */
{
    data_RealType          Value;         /* point value       */
    data_TimeStampType     TimeStamp;     /* time stamp        */
    data_FlagType          Flags;         /* quality code      */
} ldDataRealQTimeTagType;

typedef struct ldDataRealQExtType         /* type = PT_DATA_REALQ_EXT */
{
    data_RealType          Value;         /* point value       */
    data_TimeStampType     TimeStamp;     /* time stamp        */
    data_FlagType          Flags;         /* quality code      */
    data_CovCounterType    COVCount;      /* COV Counter       */
} ldDataRealQExtType;


/*
 *
 * ControlPoint Type Descriptions
 *
 */

/*
 *
 * Protection Equipment Type Descriptions
 *
 */


/*
 * Universal data value definition area.
 */

typedef union ldUniversalDataDefType
{
    struct ldStateDefType                 d0;
    struct ldStateExtDefType              d1;

    struct ldDataDefType                  d2;
    struct ldDataExtDefType               d3;
} ldUniversalDataDefType;


/*
 * Universal data value storage area.
 */
typedef union ldUniversalValueAreaType
{
           ldDataStateType                t0;
           ldDataStateQType               t1;
    struct ldDataStateQTimeTagType        t2;
    struct ldDataStateQExtType            t3;

    struct ldDataDiscreteType             t4;
    struct ldDataDiscreteQType            t5;
    struct ldDataDiscreteQTimeTagType     t6;
    struct ldDataDiscreteQExtType         t7;

    struct ldDataRealType                 t8;
    struct ldDataRealQType                t9;
    struct ldDataRealQTimeTagType         t10;
    struct ldDataRealQExtType             t11;
} ldUniversalValueAreaType;


/*
 * ICCP PE local config type definitions
 */

typedef enum icpeStateType
{
    icpeStartEsCfg,               /* 0, child state only */
    icpeDoneEsCfg,                /* 1, child state only */
    icpeStartUiCfg,               /* 2, child state only */
    icpeReadUiCfg,                /* 3, child state only */
    icpeWaitAssoc,                /* 4, child state only */
    icpeWaitUp,                   /* 5, child state only */
    icpeOperational,              /* 6, child state only */
    icpeWaitDown,                 /* 7, child state only */
    icpeIdle,                     /* 8, child state only */
    icpeCold,                     /* 9, parent state only */
    icpeParent                    /* 10, parent state only */
} icpeStateType;

typedef enum icpeEventType
{
    icpeStartLinkEvent,
    icpeStopLinkEvent,
    icpeAssocEvent,
    icpeLinkUpEvent,
    icpeLinkDownEvent,
    icpeTimeOutEvent 
} icpeEventType;

/*
 *****  NOTE  *****  NOTE  *****  NOTE  *****  NOTE  *****
 *
 *  Any change to the ICCP types below may require change
 *  to MMS type definition in iccp.c
 *
 *****  NOTE  *****  NOTE  *****  NOTE  *****  NOTE  *****
 */

/*
 * ICCP Supported Feature and Version Objects
 */

typedef unsigned short  supportedFeaturesType;

typedef struct ldSupportedFeaturesType
{
    unsigned short       type;          /* should always be PT_FEATURES */
    icChar                 features[2];   /* Supported Features object */
    short                scope;         /* Scope VMD_SPEC, DOM_SPEC, AA_SPEC */
    short                nameSize;      /* Number of characters in name not
                                           including zero byte terminator  */
    char                 name[1];       /* Name, nameSize+1 is actual
                                           array size                      */
} ldSupportedFeaturesType;

typedef struct ldICCPVersionType
{
    short                type;          /* should always be PT_VERSION_ICCP
                                           or PT_VERSION_TASE */
    short                MajorVersionNumber;  /* Major version number */
    short                MinorVersionNumber;  /* Minor version number */
    short                scope;         /* Scope VMD_SPEC, DOM_SPEC, AA_SPEC */
    short                nameSize;      /* Number of characters in name not
                                           including zero byte terminator  */
    char                 name[1];       /* Name, nameSize+1 is actual
                                           array size                      */
} ldICCPVersionType;

/*
 * visible string 32 object.
 */

typedef struct visibleStringType
{
    short                type;          /* should always be PT_VISIBLE_STRING */
    char                 string[MAX_IDENT_LEN+1]; /* visible string 32 char */
    short                scope;         /* Scope VMD_SPEC, DOM_SPEC, AA_SPEC */
    short                nameSize;      /* Number of characters in name not
                                           including zero byte terminator  */
    char                 name[1];       /* Name, nameSize+1 is actual
                                           array size                      */
} visibleStringType;

/*
 *  define MMSObjectName as object_name from MMSEASE
 *
 */

typedef struct MMSObjectName
{
    unsigned char Scope;
    icChar          DomainName  [MAX_IDENT_LEN+1];
    icChar          Name        [MAX_IDENT_LEN+1];
} MMSObjectName;

/*
 * MMS Object Name Type
 */

typedef struct mmsObjectNameType
{
    short                type;          /* should always be PT_OBJECT_NAME */
    MMSObjectName        mmsObj;        /* visible string 32 char object */
    short                scope;         /* Scope VMD_SPEC, DOM_SPEC, AA_SPEC */
    short                nameSize;      /* Number of characters in name not
                                           including zero byte terminator  */
    char                 name[1];       /* Name, nameSize+1 is actual
                                           array size                      */
} mmsObjectNameType;

/*
 * Define timeStamp object.
 */

typedef struct ldTimeStampType
{
    short                type;          /* should always be PT_TIMESTAMP */
    GMTBasedSType        GMTBasedS;     /* time stamp in seconds          */
    short                scope;         /* Scope VMD_SPEC, DOM_SPEC, AA_SPEC */
    short                nameSize;      /* Number of characters in name not
                                           including zero byte terminator  */
    char                 name[1];       /* Name, nameSize+1 is actual
                                           array size                      */
} ldTimeStampType;

/*
 *  Data Set Transfer Conditions
 *
 *  BitString Definition for DSConditions
 *
 *        +--------- IntervalTimeOut
 *        | +------- IntegrityTimeOut
 *        | | +----- ObjectChange
 *        | | | +--- OperatorRequest
 *        | | | | +- OtherExternalEvent
 *        | | | | |
 *  bit = 0 1 2 3 4 5 6 7
 */
#define DSC_ALL                0xff  /* all condition */
#define DSC_INTERVAL_TIMEOUT   0x80  /* report every interval timeout */
#define DSC_INTEGRITY_TIMEOUT  0x40  /* report when integrity time interval
                                        expires */
#define DSC_OBJECT_CHANGE      0x20  /* report when value changes by more
                                        than a deadband amount */
#define DSC_OPERATOR_REQUEST   0x10  /* report upon server operator request
                                        - unused by this implementation */
#define DSC_OTHER_EXTERNAL_EVENT 0x08  /* Other external event */

/*
 * ICCP Transfer set object.
 */

typedef icChar DSConditionsType;


typedef struct DSTransferSetType
{
    MMSObjectName             DataSet;
    GMTBasedSType             StartTime;
    timeIntervalSType         Interval;              /* in seconds */
    timeIntervalSType         TLE;                   /* in seconds */
    timeIntervalSType         BufferTime;            /* in seconds */
    timeIntervalSType         IntegrityCheck;        /* in seconds */
    DSConditionsType          DSConditions;
    icBoolean                 Blockdata;
    icBoolean                 Critical;
    icBoolean                 RBE;
    icBoolean                 Status;
    short                     EventCode;
} DSTransferSetType;

/*
 * Define seconds object.
 */

#ifdef SUN_TEST                 /* ===== work around SUN problem ===== */
#else                           /* ===== if SUN addressing ok    ===== */
typedef struct ldTimeIntervalSType
{
    short                type;          /* should always be PT_SECONDS */
    timeIntervalSType    seconds;       /* seconds to elapse */
    short                scope;         /* Scope VMD_SPEC, DOM_SPEC, AA_SPEC */
    short                nameSize;      /* Number of characters in name not
                                           including zero byte terminator  */
    char                 name[1];       /* Name, nameSize+1 is actual
                                           array size                      */
} ldTimeIntervalSType;

#endif                          /* ===== endif of SUN_TEST       ===== */

/*
 * Define Event_Code object.
 */

typedef struct eventCodeType
{
    short                type;          /* should always be PT_EVENT_CODE */
    short                code;          /* event code that trigger the report */
    short                scope;         /* Scope VMD_SPEC, DOM_SPEC, AA_SPEC */
    short                nameSize;      /* Number of characters in name not
                                           including zero byte terminator  */
    char                 name[1];       /* Name, nameSize+1 is actual
                                           array size                      */
} eventCodeType;

/*
 * Define Conditions object.
 */

typedef struct conditionsType
{
    short                type;          /* should always be PT_CONDITIONS */
    DSConditionsType     conditions;    /* Conditions that occur while waiting
                                           for buffertime to expire */
    short                scope;         /* Scope VMD_SPEC, DOM_SPEC, AA_SPEC */
    short                nameSize;      /* Number of characters in name not
                                           including zero byte terminator  */
    char                 name[1];       /* Name, nameSize+1 is actual
                                           array size                      */
} conditionsType;

/*
 * Define transfer condition table.
 *
 */

typedef struct conditionDefEntryType
{
    char              groupName[cNormName+1];/* condition group name */
    short             transferValueC;      /* Transfer Value Conditions */
    GMTBasedSType     startTime;           /* Start Time (secs) */
    timeIntervalSType periodicOffset;      /* top of hour offset for 
                                              periodic transfer (secs) */
    timeIntervalSType interval;            /* Periodic interval (secs) */
    timeIntervalSType bufferTime;          /* Interval for exception  
                                              buffering (secs) */
    timeIntervalSType integrity;           /* Integrity interval (secs)  
                                              for TV_RBE only */
    struct icTransferGroup   *groupPtr;    /* Ptr to Transfer Group entry */
    void             (*transferReject)   ( icInt status, icLinkId linkId );
                                     /* procedure to call if defvlist failed */
} conditionDefEntryType;

typedef struct conditionDefTableType
{
    int         entries;                /* Number of array entries in use */
    int         entriesAlloc;           /* Number of allocated array entries */
    conditionDefEntryType conditionDefArray[1];
                                        /* Array of condition table entries,
                                           in alphabetic order by name. */
} conditionDefTableType;

typedef struct conditionEntryType
{
    char              groupName[cNormName+1];/* condition group name */
    icBoolean         dataSetAssigned;     /* TRUE if assigned to a Data Set*/
    ldValueType       valuePtr;            /* Pointer to type of local data */
} conditionEntryType;

typedef struct conditionTableType
{
    int         entries;                /* Number of array entries in use */
    int         entriesAlloc;           /* Number of allocated array entries */
    conditionEntryType conditionArray[1];
                                        /* Array of condition table entries,
                                           in alphabetic order by name. */
} conditionTableType;