|
CICS Transaction Gateway Statistics
API v1.1.0.1 - Statistics Protocol v1.0.0.0
|
Go to the documentation of this file.
80 char ** protocolVersPtr);
122 char ** protocolVersPtr);
716 #define CTG_STAT_OK 0
720 #define CTG_STAT_ERR_NULLGWTOK -100
726 #define CTG_STAT_ERR_BADGWTOK -101
731 #define CTG_STAT_ERR_LOSTGWCON -102
735 #define CTG_STAT_ERR_NULLPARM -103
739 #define CTG_STAT_ERR_TRACELEVEL -104
744 #define CTG_STAT_ERR_NULLVERSPTR -105
749 #define CTG_STAT_ERR_APIRESULTSET -106
754 #define CTG_STAT_ERR_BADPORT -107
758 #define CTG_STAT_ERR_NULLGWTOKPTR -108
762 #define CTG_STAT_ERR_NULLPTR -109
766 #define CTG_STAT_ERR_NULLRSBUFFER -110
771 #define CTG_STAT_ERR_MALLOCFAIL -111
775 #define CTG_STAT_ERR_EMPTYRESULTSET -112
779 #define CTG_STAT_ERR_ENDOFRESULTSET -113
783 #define CTG_STAT_ERR_BADGWTOKLIST -115
789 #define CTG_STAT_ERR_BADRSOWNER -116
793 #define CTG_STAT_ERR_BADRSTOKEN -117
797 #define CTG_STAT_ERR_CONNECTFAILED -118
801 #define CTG_STAT_ERR_BADRSTYPE -119
807 #define CTG_STAT_ERR_ICONV -120
812 #define CTG_STAT_ERR_LOCKFAIL -121
817 #define CTG_STAT_ERR_COMMSFAIL -122
822 #define CTG_STAT_ERR_PIDMISMATCH -123
827 #define CTG_STAT_ERR_TIDMISMATCH -124
831 #define CTG_STAT_ERR_NULLRSTOKPTR -125
835 #define CTG_STAT_ERR_NULLQUERYSTRING -126
839 #define CTG_STAT_ERR_NULLRSTOK -127
843 #define CTG_STAT_ERR_NULLIDDATAPTR -128
847 #define CTG_STAT_ERR_NULLSTATDATAPTR -129
852 #define CTG_STAT_ERR_TRACEFILE -130
857 #define CTG_STAT_ERR_NOQUERYIDS -131
861 #define CTG_STAT_ERR_BADHOST -132
865 #define CTG_STAT_ERR_NULLADDRESS -133
869 #define CTG_STAT_ERR_CONNECTTIMEOUT -134
873 #define CTG_STAT_ERR_CONNECTREFUSED -135
878 #define CTG_STAT_ERR_GATEWAYUNREACHABLE -136
886 #define CTG_STAT_TRACE_LEVEL0 0
890 #define CTG_STAT_TRACE_LEVEL1 1
895 #define CTG_STAT_TRACE_LEVEL2 2
900 #define CTG_STAT_TRACE_LEVEL3 3
905 #define CTG_STAT_TRACE_LEVEL4 4
909 #define CTG_STAT_NULL_GWTOK NULL
913 #define CTG_STAT_NULL_RSTOK NULL
917 #define CTG_STAT_API_VERSION "1_1_0_1"
922 #define CTG_STAT_DLL_VERSION "10.1.0.0"
int getStatsByStatGroupId(CTG_GatewayToken_t gwTok, char *idQueryPtr, CTG_ResultSetToken_t *statRsTokPtr)
Takes a gateway token, a query string of StatGroupIds and a result set token.
int getNextId(CTG_ResultSetToken_t idRsTok, CTG_IdData_t *idDataPtr)
Takes an id result set and populates an CTG_IdData_t variable with details of the next id in the set.
int getStatsByStatId(CTG_GatewayToken_t gwTok, char *idQueryPtr, CTG_ResultSetToken_t *statRsTokPtr)
Takes a gateway token, a query string of StatIds and a result set token pointer.
int getStatsAPIVersion(char **apiVersPtr)
Takes the address of a character pointer to be modified.
int copyResultSet(CTG_ResultSetToken_t srcRsTok, CTG_ResultSetToken_t *tarRsTokPtr)
Takes a result set token as a source, and a result set token pointer as a target.
int dumpResultSet(CTG_ResultSetToken_t rsTok)
Takes a result set token and writes a representation of that result set in printable characters to th...
int getStatIds(CTG_GatewayToken_t gwTok, CTG_ResultSetToken_t *statIdRsTokPtr)
Takes a gateway token and a result set token pointer.
struct _CTG_GatewayToken_t * CTG_GatewayToken_t
CTG_GatewayToken_t represents a connection to a specific Gateway daemon.
int dumpState()
Writes internal API debugging information to the trace destination, irrespective of trace settings.
int freeResultSet(CTG_ResultSetToken_t *rsTokPtr)
Takes a result set token pointer for an application-owned result set, created by copyResultSet(),...
int getStatIdsByStatGroupId(CTG_GatewayToken_t gwTok, char *idQueryPtr, CTG_ResultSetToken_t *statIdRsTokPtr)
Takes a gateway token, a query string of StatGroupIds and a result set token pointer.
int getFirstId(CTG_ResultSetToken_t idRsTok, CTG_IdData_t *idDataPtr)
Takes an id result set token and populates a CTG_IdData_t variable with details of the first id in th...
int setAPITraceFile(char *traceFileNamePtr)
Takes a character pointer to a null-terminated string representing the desired trace file destination...
int getIdQuery(CTG_ResultSetToken_t anyRsTok, char **idQueryPtr)
Takes a result set token and the address of a char pointer.
int openGatewayConnection(int port, CTG_GatewayToken_t *gwTokPtr, char **protocolVersPtr)
Establishes a connection to a local Gateway daemon statistics protocol handler using the specified po...
int setAPITraceLevel(int traceState)
Takes an int variable representing the desired trace level and sets the API trace level accordingly.
int getFirstStat(CTG_ResultSetToken_t statRsTok, CTG_StatData_t *statDataPtr)
Takes a Stat result set token and populates a CTG_StatData_t variable with details of the first stati...
int getNextStat(CTG_ResultSetToken_t statRsTok, CTG_StatData_t *statDataPtr)
Takes a Stat result set token and populates a CTG_StatData_t variable with details of the next StatId...
int getResourceGroupIds(CTG_GatewayToken_t gwTok, CTG_ResultSetToken_t *resgrpIdRsTokPtr)
Takes a gateway token and a result set token pointer.
int openRemoteGatewayConnection(char *address, int port, CTG_GatewayToken_t *gwTokPtr, char **protocolVersPtr)
Establishes a connection to a Gateway daemon statistics protocol handler using the specified hostname...
int closeAllGatewayConnections()
Attempts to free all resources held by the API, including open Gateway daemon connections.
struct _CTG_ResultSetToken_t * CTG_ResultSetToken_t
CTG_ResultSetToken_t represents the results of an API call to obtain id or statistic data.
int closeGatewayConnection(CTG_GatewayToken_t *gwTokPtr)
Closes the connection to the Gateway daemon associated with the specified Gateway token.
CTG_StatData_t encapsulates a single StatId and value pair.
int getStats(CTG_GatewayToken_t gwTok, CTG_ResultSetToken_t *statRsTokPtr)
Takes a gateway token, a query string of StatIds and a result set token pointer.
CTG_IdData_t encapsulates a ResourceGroupId, ResourceID or StatId.
int getAPITraceLevel(int *traceStatePtr)
Takes a pointer to an int variable, and sets that variable to the current API trace level.