tibemsAdmin provides an administrative connection to the server. To use these functions, first create an administrative connection to the server with tibemsAdmin_Create. With that connection you can retrieve information about the server and its components at runtime.
tibems_status tibemsAdmin_Close(
tibems_status tibemsAdmin_Create(
sslParams has usage pointer.
Establish SSL communication using these parameters. See the section on SSL server parameters in the TIBCO Enterprise Message Service User’s Guide for more information.
• The call could not communicate with a server because of mismatched SSL and TCP protocols.
• The server rejected the connection because the username or password was invalid.tibems_status tibemsAdmin_GetCommandTimeout(
Gets the command timeout in milliseconds. The command timeout determines how long to wait for the server to respond to a command. If the server does not respond within the timeout limit, the command throws an exception. The default timeout is 60000 (60 seconds).tibems_status tibemsAdmin_GetConsumer(
The consumer ID for which the function will retrieve information.Returns the consumer object with specified ID. The returned consumer object contains information about consumer known to server, including details, available statistics. If a consumer with the specified ID does not exist, the function returns NULL.
The administrative query timed out while waiting for a server response. tibems_status tibemsAdmin_GetConsumers(
collection has usage pointer.
The function stores the returned consumer data in the location specified here, as a collection of tibemsConsumerInfo objects. connectionID is reserved for future use and must be set to zero. If specified, only consumers for connections that use the specified user name will be returned. Specify NULL if all consumers should be returned. If specified, only consumers on destinations of the same type and matching this destination name will be returned. destination can be:
•
• TIBEMS_INVALID_ADMIN_ID to return all consumers. When TRUE, this parameter specifies that only durable topic subscribers should be returned.This parameter is applied only to topic subscribers, and when included prevents the function from returning non-durable topic consumers. However, it does not affect which queue consumers are returned. Specifies what information will be returned for each consumer that matches the filter criteria. Possible values for this parameter are:
• GET_STAT—gets a tibemsStatData for each consumer.
• When no flag is specified, the returned information does not include statistics.If statistics are disabled in the server, no statistics will be returned regardless of the flag specified in this parameter.Returns a list of consumers matching the specified filters. The consumers are returned in a tibemsCollection; if no consumers matching the filter criteria exist in the server, then no tibemsCollection will be returned.The returned consumers are not sorted and are placed in the tibemsCollection object in any order. Your application may need to sort the consumers into a specific order if required.For example, this call returns all consumers known to the server, but does not include statistical information for each consumer:tibemsAdmin admin;tibems_status status;status = tibemsAdmin_GetConsumers(admin, &consumerInfoCollection, 0L, NULL, TIBEMS_ADMIN_INVALID_ID, TIBEMS_FALSE, 0);tibemsAdmin admin;tibems_status status;status = tibemsAdmin_GetConsumers(admin, &consumerInfoCollection, 0L, NULL, TIBEMS_ADMIN_INVALID_ID, TIBEMS_TRUE, 0);This call returns all durable topic consumers that subscribe to any topic matching topic news.*. If statistics are enabled in the server, the returned tibemsConsumerInfo objects will include detailed statistics about the consumers.tibemsAdmin admin;tibems_status status;tibemsTopicInfo topicInfo;status = tibemsAdmin_GetConsumers(admin, &consumerInfoCollection, 0L, NULL, topicInfo, TIBEMS_TRUE, TIBEMS_GET_DETAILED_STAT);This call returns all queue consumers created by user OrderProcessor and receiving messages from all queues matching name purchase.order.>. Each tibemsConsumerInfo object will include the full statistics available for the consumer.tibemsAdmin admin;tibems_status status;tibemsQueueInfo queueInfo;status = tibemsAdmin_GetConsumers(admin, &consumerInfoCollection, 0L, "OrderProcessor", queueInfo, TIBEMS_FALSE, TIBEMS_GET_DETAILED_STAT);
The administrative query timed out while waiting for a server response. tibems_status tibemsAdmin_GetInfo(
The administrative query timed out while waiting for a server response.tibems_status tibemsAdmin_GetProducerStatistics(
prodInfos has usage pointer.
The function stores the returned producer data in the location specified here, as a collection of tibemsProducerInfo objects. If specified, only producers for connections that use the specified user name will be returned. Specify NULL if all producers should be returned. If specified, only producers on destinations of the same type and matching this destination name will be returned. destination can be:
•
• TIBEMS_INVALID_ADMIN_ID to return all producers.Returns information about message producers, including the statistical information about producers with specified parameters.
The administrative query timed out while waiting for a server response. tibems_status tibemsAdmin_GetQueue(
The function will store information about the specified queue in this location. This function gets a tibemsQueueInfo object for the specified queue name. If the queueName does not exist, the function returns TIBEMS_NOT_FOUND.
The administrative query timed out while waiting for a server response. No queue found matching the specified queueName.tibems_status tibemsAdmin_GetQueues(
collection has usage pointer.
The function stores the returned queue data in the location specified here, as a collection of tibemsQueueInfo objects. The pattern may contain the wildcards * and >. A pattern of > or NULL will return all queues that exist in the server. See the TIBCO Enterprise Message Service User’s Guide for information about working with wildcards in queues. The permanence type of the queue must match the type given here. Possible permanence types are:
• TIBEMS_DEST_GET_ALL – Return all queues that match the pattern.
• TIBEMS_DEST_GET_STATIC – Return only static queues that match the pattern.
• TIBEMS_DEST_GET_DYNAMIC – Return only dynamic queues that match the pattern.
• TIBEMS_DEST_GET_NOTEMP – Do not return any temporary queues.A NULL value matches all queues.
The administrative query timed out while waiting for a server response. No queues found matching the specified pattern and performance type.tibems_status tibemsAdmin_GetTopic(
This function gets a tibemsTopicInfo object for the specified topic name. If the topicName does not exist, the function returns TIBEMS_NOT_FOUND.
The administrative query timed out while waiting for a server response. No topic found matching the specified topicName.tibems_status tibemsAdmin_GetTopics(
collection has usage pointer.
The function stores the returned topic data in the location specified here, as a collection of tibemsTopicInfo objects. The pattern may contain the wildcards * and >. A pattern of > or NULL will return all topics. See the TIBCO Enterprise Message Service User’s Guide for information about working with wildcards in topics. The permanence type of the topic must match the type given here. Possible permanence types are:
• TIBEMS_DEST_GET_ALL – Return all topics that match the pattern.
• TIBEMS_DEST_GET_STATIC – Return only static topics that match the pattern.
• TIBEMS_DEST_GET_DYNAMIC – Return only dynamic topics that match the pattern.
• TIBEMS_DEST_GET_NOTEMP – Do not return any temporary topics.A NULL value matches all topics.
The administrative query timed out while waiting for a server response. No topics found matching the specified pattern and performance type.tibems_status tibemsAdmin_SetCommandTimeout(
The length of time, in milliseconds, to wait for the server to respond to a command. When not specified, the default command timeout is 60000 (60 seconds).Sets the command timeout. The command timeout determines how long, in milliseconds, the command waits for the server to respond. If the server does not respond within the timeout limit, the command throws an exception. The default timeout is 60000 (60 seconds).Set an exception listener for the connection used by the administration API to communicate with the EMS server.tibems_status tibemsAdmin_SetExceptionListener(
Resister the exception listener callback on this administration connection. For more information about exception listeners, see the TIBCO Enterprise Message Service User’s Guide. This is an alternate pathway for alerting a client program of connection problems. The program defines an exception listener callback function, and calls this function to register the callback and a closure argument. When the client library detects a connection problem, it calls the callback with a status code that identifies the problem.
Copyright © TIBCO Software Inc. All Rights Reserved.