Chapter 15 Administration : tibemsTopicInfo

tibemsTopicInfo
Type
Purpose
Represent a topic that is configured in the server.
 
Related Types
tibemsStatData on page 491
tibemsTopicInfo_Create
Function
Purpose
Create a tibemsTopicInfo object.
C Declaration
tibems_status tibemsTopicInfo_Create(
    tibemsTopicInfo* topicInfo,
    const char* topicName);
COBOL Call
CALL "tibemsTopicInfo_Create"
 USING BY REFERENCE topicInfo,
       BY REFERENCE name,
       RETURNING tibems-status
END-CALL.
Parameters
 
topicInfo
Store the new tibemsTopicInfo object in this location.
topicName
Create the tibemsTopicInfo object with this name. The topicName can include wildcards.
Remarks
This function is used to create a tibemsTopicInfo object with the specified name. The tibemsTopicInfo object may then be passed as the tibemsDestinationInfo argument to the tibemsAdmin_GetConsumers and tibemsAdmin_GetProducerStatistics functions. The name may include wildcards.
For more information on wildcards, see Wildcards of the TIBCO Enterprise Message Service User’s Guide.
See Also
tibemsQueueInfo_Create on page 472
tibemsAdmin_GetConsumers on page 418
tibemsAdmin_GetProducerStatistics on page 422
tibemsTopicInfo_Destroy
Function
Purpose
Destroy a tibemsTopicInfo object.
C Declaration
tibems_status tibemsTopicInfo_Destroy(
    tibemsTopicInfo topicInfo);
COBOL Call
CALL "tibemsTopicInfo_Destroy"
 USING BY VALUE topicInfo,
       RETURNING tibems-status
END-CALL.
Parameters
 
Destroy this tibemsTopicInfo object.
See Also
tibemsQueueInfo_Destroy on page 473
 
tibemsTopicInfo_GetActiveDurableCount
Function
Purpose
Get the current number of active durable subscribers for this topic.
C Declaration
tibems_status tibemsTopicInfo_GetActiveDurableCount(
    tibemsTopicInfo topicInfo,
    tibems_int* count);
COBOL Call
CALL "tibemsTopicInfo_GetActiveDurableCount"
 USING BY VALUE topicInfo,
       BY REFERENCE count,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsTopicInfo_GetDurableCount on page 501
tibemsTopicInfo_GetSubscriberCount on page 511
tibemsTopicInfo_GetDurableCount
Function
Purpose
Get the current number of durable subscribers for this topic.
C Declaration
tibems_status tibemsTopicInfo_GetDurableCount(
    tibemsTopicInfo topicInfo,
    tibems_int* count);
COBOL Call
CALL "tibemsTopicInfo_GetDurableCount"
 USING BY VALUE topicInfo,
       BY REFERENCE count,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsTopicInfo_GetActiveDurableCount on page 500
tibemsTopicInfo_GetSubscriberCount on page 511
 
tibemsTopicInfo_GetFlowControlMaxBytes
Function
Purpose
Get the volume of pending message bytes at which flow control is enabled for the topic.
C Declaration
tibems_status tibemsTopicInfo_GetFlowControlMaxBytes(
    tibemsTopicInfo topicInfo,
    tibems_long* maxBytes);
COBOL Call
CALL "tibemsTopicInfo_GetFlowControlMaxBytes"
 USING BY VALUE topicInfo,
       BY REFERENCE maxBytes,
       RETURNING tibems-status
END-CALL.
Parameters
 
The value stored indicates the volume of pending messages, in bytes, that the server will store for the topic before enabling flow control. A value of 0 indicates that flow control will never be enabled.
See Also
tibemsQueueInfo_GetFlowControlMaxBytes on page 475
 
tibemsTopicInfo_GetInboundStatistics
Function
Purpose
Get inbound statistics for this topic.
C Declaration
tibems_status tibemsTopicInfo_GetInboundStatistics(
    tibemsTopicInfo topicInfo,
    tibemsStatData* statData);
COBOL Call
CALL "tibemsTopicInfo_GetInboundStatistics"
 USING BY VALUE topicInfo,
       BY REFERENCE statData,
       RETURNING tibems-status
END-CALL.
Parameters
 
Remarks
This function retrieves the inbound statistics for the topic. Inbound statistics include all messages sent by EMS clients and routed servers.
See Also
tibemsQueueInfo_GetInboundStatistics on page 476
 
tibemsTopicInfo_GetMaxBytes
Function
Purpose
Get the maximum number of bytes of pending messages bound for this topic that the server will store.
C Declaration
tibems_status tibemsTopicInfo_GetMaxBytes(
    tibemsTopicInfo topicInfo,
    tibems_long* maxBytes);
COBOL Call
CALL "tibemsTopicInfo_GetMaxBytes"
 USING BY VALUE topicInfo,
       BY REFERENCE maxBytes,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsQueueInfo_GetMaxBytes on page 477
tibemsTopicInfo_GetMaxMsgs
Function
Purpose
Get the maximum number of pending messages bound for the topic that the server will store.
C Declaration
tibems_status tibemsTopicInfo_GetMaxMsgs(
    tibemsTopicInfo topicInfo,
    tibems_long* maxMsgs);
COBOL Call
CALL "tibemsTopicInfo_GetMaxMsgs"
 USING BY VALUE topicInfo,
       BY REFERENCE maxMsgs,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsQueueInfo_GetMaxMsgs on page 478
tibemsTopicInfo_GetName
Function
Purpose
Get the name of this topic.
C Declaration
tibems_status tibemsTopicInfo_GetName(
    tibemsTopicInfo topicInfo,
    char* name,
    tibems_int name_len);
COBOL Call
CALL "tibemsTopicInfo_GetName"
 USING BY VALUE topicInfo,
       BY REFERENCE name,
       BY VALUE name_len,
       RETURNING tibems-status
END-CALL.
Parameters
 
Length of the name buffer.
See Also
tibemsQueueInfo_GetName on page 479
tibemsTopicInfo_GetOutboundStatistics
Function
Purpose
Get outbound statistics for this topic.
C Declaration
tibems_status tibemsTopicInfo_GetOutboundStatistics(
    tibemsTopicInfo topicInfo,
    tibemsStatData* statData);
COBOL Call
CALL "tibemsTopicInfo_GetOutboundStatistics"
 USING BY VALUE topicInfo,
       BY REFERENCE statData,
       RETURNING tibems-status
END-CALL.
Parameters
 
Remarks
This function retrieves the outbound statistics for the topic. Outbound statistics include all messages delivered by the topic to EMS clients and routed servers.
See Also
tibemsQueueInfo_GetOutboundStatistics on page 480
tibemsTopicInfo_GetOverflowPolicy
Function
Purpose
Get the overflow policy for this topic.
C Declaration
tibems_status tibemsTopicInfo_GetOverflowPolicy(
    tibemsTopicInfo topicInfo,
    tibems_int* overflowPolicy);
COBOL Call
CALL "tibemsTopicInfo_GetOverflowPolicy"
 USING BY VALUE topicInfo,
       BY REFERENCE overflowPolicy,
       RETURNING tibems-status
END-CALL.
Parameters
 
Remarks
This function retrieves the overflow policy for the queue. Possible values are:
For more information about overflow policies, see the TIBCO Enterprise Message Service User’s Guide.
See Also
tibemsQueueInfo_GetOverflowPolicy on page 481
tibemsTopicInfo_GetPendingMessageCount
Function
Purpose
Get the total number of pending messages for this topic.
C Declaration
tibems_status tibemsTopicInfo_GetPendingMessageCount(
    tibemsTopicInfo topicInfo,
    tibems_long* count);
COBOL Call
CALL "tibemsTopicInfo_GetPendingMessageCount"
 USING BY VALUE topicInfo,
       BY REFERENCE size,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsQueueInfo_GetPendingMessageCount on page 482
tibemsTopicInfo_GetPendingMessageSize
Function
Purpose
Get the total size of all pending messages for this topic.
C Declaration
tibems_status tibemsTopicInfo_GetPendingMessageSize(
    tibemsTopicInfo topicInfo,
    tibems_long* count);
COBOL Call
CALL "tibemsTopicInfo_GetPendingMessageSize"
 USING BY VALUE topicInfo,
       BY REFERENCE size,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsQueueInfo_GetPendingMessageSize on page 483
tibemsTopicInfo_GetSubscriberCount
Function
Purpose
Get the number of subscribers on this topic.
C Declaration
tibems_status tibemsTopicInfo_GetSubscriberCount(
    tibemsTopicInfo topicInfo,
    tibems_int* count);
COBOL Call
CALL "tibemsTopicInfo_GetSubscriberCount"
 USING BY VALUE topicInfo,
       BY REFERENCE count,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsTopicInfo_GetActiveDurableCount on page 500
tibemsTopicInfo_GetDurableCount on page 501
tibemsQueueInfo_GetReceiverCount on page 484