Administration : tibemsProducerInfo

tibemsProducerInfo
Type
Purpose
Represent a message producer.
 
Related Types
tibemsDetailedDestStat on page 462
tibemsStatData on page 495
tibemsProducerInfo_Destroy
Function
Purpose
Destroy a producerInfo object.
C Declaration
tibems_status tibemsProducerInfo_Destroy(
    tibemsProducerInfo producerInfo);
COBOL Call
CALL "tibemsProducerInfo_Destroy"
 USING BY VALUE producerInfo,
       RETURNING tibems-status
END-CALL.
Parameters
 
The tibemsProducerInfo object to destroy.
tibemsProducerInfo_GetCreateTime
Function
Purpose
Get the producer create time in milliseconds.
C Declaration
tibems_status tibemsProducerInfo_GetCreateTime(
    tibemsProducerInfo producerInfo,
    tibems_long* created);
COBOL Call
CALL "tibemsProducerInfo_GetCreateTime"
USING BY VALUE producerInfo,
      BY REFERENCE created,
      RETURNING tibems-status
END-CALL.
Parameters
 
tibemsProducerInfo_GetDestinationName
Function
Purpose
Get the producer's destination name.
C Declaration
tibems_status tibemsProducerInfo_GetDestinationName(
    tibemsProducerInfo producerInfo,
    char* name
    tibems_int name_len);
COBOL Call
CALL "tibemsProducerInfo_GetDestinationName"
 USING BY VALUE producerInfo,
       BY REFERENCE destName,
       BY VALUE name_len,
       RETURNING tibems-status
END-CALL.
Parameters
 
Length of the name buffer.
 
tibemsProducerInfo_GetDestinationType
Function
Purpose
Get the producer's destination type.
C Declaration
tibems_status tibemsProducerInfo_GetDestinationType(
    tibemsProducerInfo producerInfo,
    tibemsDestinationType* type);
COBOL Call
CALL "tibemsProducerInfo_GetDestinationType"
 USING BY VALUE producerInfo,
       BY REFERENCE destType,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsDestinationType on page 143
 
tibemsProducerInfo_GetDetailedStatistics
Function
Purpose
Get detailed statistics for an unidentified producer.
C Declaration
tibems_status tibemsProducerInfo_GetDetailedStatistics(
    tibemsProducerInfo producerInfo,
    tibemsCollection* collection;
COBOL Call
CALL "tibemsProducerInfo_GetDetailedStatistics"
 USING BY VALUE producerInfo,
       BY REFERENCE collection,
       RETURNING tibems-status
END-CALL.
 
collection has usage pointer.
Parameters
 
Remarks
Gets detailed statistics for an unidentified producer, giving a breakdown of the producer's aggregate statistics across all destinations that it has published messages on.
This function returns NULL when there are no detailed statistics available for the producer. This can happen when, for example, detailed statistics for producers are disabled in the server.
See Also
tibemsDetailedDestStat on page 462
 
tibemsProducerInfo_GetID
Function
Purpose
Get the producer’s ID.
C Declaration
tibems_status tibemsProducerInfo_GetID(
    tibemsProducerInfo producerInfo,
    tibems_long* id);
COBOL Call
CALL "tibemsProducerInfo_GetID"
 USING BY VALUE producerInfo,
       BY REFERENCE id,
       RETURNING tibems-status
END-CALL.
Parameters
 
 
tibemsProducerInfo_GetStatistics
Function
Purpose
Get total statistics for a producer.
C Declaration
tibems_status tibemsProducerInfo_GetStatistics(
    tibemsProducerInfo producerInfo,
    tibemsStatData* statData);
COBOL Call
CALL "tibemsProducerInfo_GetStatistics"
 USING BY VALUE producerInfo,
       BY REFERENCE stat,
       RETURNING tibems-status
END-CALL.
Parameters
 
The function stores the statistics in this location. The stored value will be NULL if statistics are disabled in the server and so there are none available for the producer.
See Also
tibemsStatData on page 495