Chapter 15 Administration : tibemsQueueInfo

tibemsQueueInfo
Type
Purpose
Represent a message queue that is configured in the EMS server.
 
Related Types
tibemsQueue on page 150
tibemsStatData on page 491
tibemsQueueInfo_Create
Function
Purpose
Create a tibemsQueueInfo object.
C Declaration
tibems_status tibemsQueueInfo_Create(
    tibemsQueueInfo* queueInfo,
    const char* queueName);
COBOL Call
CALL "tibemsQueueInfo_Create"
 USING BY REFERENCE queueInfo,
       BY REFERENCE name,
       RETURNING tibems-status
END-CALL.
Parameters
 
Store the new tibemsQueueInfo object in this location.
Create the tibemsQueueInfo object with this name. The queueName can include wildcards.
Remarks
This function is used to create a tibemsQueueInfo object with the specified name. The tibemsQueueInfo 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
tibemsTopicInfo_Create on page 498
tibemsAdmin_GetConsumers on page 418
tibemsAdmin_GetProducerStatistics on page 422
tibemsQueueInfo_Destroy
Function
Purpose
Destroy a tibemsQueueInfo object.
C Declaration
tibems_status tibemsQueueInfo_Destroy(
    tibemsQueueInfo queueInfo);
COBOL Call
CALL "tibemsQueueInfo_Destroy"
 USING BY VALUE queueInfo,
       RETURNING tibems-status
END-CALL.
Parameters
 
The tibemsQueueInfo object to destroy.
See Also
tibemsTopicInfo_Destroy on page 499
 
tibemsQueueInfo_GetDeliveredMessageCount
Function
Purpose
Get the total number of messages that have been delivered to consumer applications but have not yet been acknowledged.
C Declaration
tibems_status tibemsQueueInfo_GetDeliveredMessageCount(
    tibemsQueueInfo queueInfo,
    tibems_long* count);
COBOL Call
CALL "tibemsQueueInfo_GetDeliveredMessageCount"
 USING BY VALUE queueInfo,
       BY REFERENCE count,
       RETURNING tibems-status
END-CALL.
Parameters
 
 
tibemsQueueInfo_GetFlowControlMaxBytes
Function
Purpose
Get the volume of pending messages at which flow control is enabled for the queue.
C Declaration
tibems_status tibemsQueueInfo_GetFlowControlMaxBytes(
    tibemsQueueInfo queueInfo,
    tibems_long* maxBytes);
COBOL Call
CALL "tibemsQueueInfo_GetFlowControlMaxBytes"
 USING BY VALUE queueInfo,
       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 in the queue before enabling flow control. A value of 0 indicates that flow control will never be enabled.
See Also
tibemsTopicInfo_GetFlowControlMaxBytes on page 502
tibemsQueueInfo_GetInboundStatistics
Function
Purpose
Get inbound statistics for this queue.
C Declaration
tibems_status tibemsQueueInfo_GetInboundStatistics(
    tibemsQueueInfo queueInfo,
    tibemsStatData* statData);
COBOL Call
CALL "tibemsQueueInfo_GetInboundStatistics"
 USING BY VALUE queueInfo,
       BY REFERENCE statData,
       RETURNING tibems-status
END-CALL.
Parameters
 
Remarks
This function retrieves the inbound statistics for the queue. Inbound statistics include all messages sent into the queue by EMS clients and routed servers.
See Also
tibemsTopicInfo_GetInboundStatistics on page 503
tibemsQueueInfo_GetMaxBytes
Function
Purpose
Get the maximum number of bytes that the server stores of pending messages bound for this queue.
C Declaration
tibems_status tibemsQueueInfo_GetMaxBytes(
    tibemsQueueInfo queueInfo,
    tibems_long* maxBytes);
COBOL Call
CALL "tibemsQueueInfo_GetMaxBytes"
 USING BY VALUE queueInfo,
       BY REFERENCE maxBytes,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsTopicInfo_GetMaxBytes on page 504
tibemsQueueInfo_GetMaxMsgs
Function
Purpose
Get the maximum number of pending messages bound for the queue that the server will store.
C Declaration
tibems_status tibemsQueueInfo_GetMaxMsgs(
    tibemsQueueInfo queueInfo,
    tibems_long* maxMsgs);
COBOL Call
CALL "tibemsQueueInfo_GetMaxMsgs"
 USING BY VALUE queueInfo,
       BY REFERENCE maxMsgs,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsTopicInfo_GetMaxMsgs on page 505
tibemsQueueInfo_GetName
Function
Purpose
Get the name of this queue.
C Declaration
tibems_status tibemsQueueInfo_GetName(
    tibemsQueueInfo queueInfo,
    char* name,
    tibems_int name_len);
COBOL Call
CALL "tibemsQueueInfo_GetName"
 USING BY VALUE queueInfo,
       BY REFERENCE name,
       BY VALUE name_len,
       RETURNING tibems-status
END-CALL.
Parameters
 
Length of the name buffer.
See Also
tibemsTopicInfo_GetName on page 506
tibemsQueueInfo_GetOutboundStatistics
Function
Purpose
Get outbound statistics for this queue.
C Declaration
tibems_status tibemsQueueInfo_GetOutboundStatistics(
    tibemsQueueInfo queueInfo,
    tibemsStatData* statData);
COBOL Call
CALL "tibemsQueueInfo_GetOutboundStatistics"
 USING BY VALUE queueInfo,
       BY REFERENCE statData,
       RETURNING tibems-status
END-CALL.
Parameters
 
Remarks
This function retrieves the outbound statistics for the queue. Outbound statistics include all messages delivered from the queue to EMS clients and routed servers.
See Also
tibemsTopicInfo_GetOutboundStatistics on page 507
 
tibemsQueueInfo_GetOverflowPolicy
Function
Purpose
Get the overflow policy for this queue.
C Declaration
tibems_status tibemsQueueInfo_GetOverflowPolicy(
    tibemsQueueInfo queueInfo,
    tibems_int* overflowPolicy);
COBOL Call
CALL "tibemsQueueInfo_GetOverflowPolicy"
 USING BY VALUE queueInfo,
       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
tibemsTopicInfo_GetOverflowPolicy on page 508
 
tibemsQueueInfo_GetPendingMessageCount
Function
Purpose
Get the total number of pending messages for this queue.
C Declaration
tibems_status tibemsQueueInfo_GetPendingMessageCount(
    tibemsQueueInfo queueInfo,
    tibems_long* count);
COBOL Call
CALL "tibemsQueueInfo_GetPendingMessageCount"
 USING BY VALUE queueInfo,
       BY REFERENCE size,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsTopicInfo_GetPendingMessageCount on page 509
tibemsQueueInfo_GetPendingMessageSize
Function
Purpose
Get the total size of all pending messages for this queue.
C Declaration
tibems_status tibemsQueueInfo_GetPendingMessageSize(
    tibemsQueueInfo queueInfo,
    tibems_long* size);
COBOL Call
CALL "tibemsQueueInfo_GetPendingMessageSize"
 USING BY VALUE queueInfo,
       BY REFERENCE size,
       RETURNING tibems-status
END-CALL.
Parameters
 
See Also
tibemsTopicInfo_GetPendingMessageSize on page 510
tibemsQueueInfo_GetReceiverCount
Function
Purpose
Get the number of active receivers on this queue.
C Declaration
tibems_status tibemsQueueInfo_GetReceiverCount(
    tibemsQueueInfo queueInfo,
    tibems_int* count);
COBOL Call
CALL "tibemsQueueInfo_GetReceiverCount"
 USING BY VALUE queueInfo,
       BY REFERENCE count,
       RETURNING tibems-status
END-CALL.
Parameters