[TIBCO.EMS .NET client library 5.1 documentation]
The Tibems type exposes the following members.
Methods
Name | Description | |
---|---|---|
![]() ![]() | CalculateMessageSize |
Calculates and returns total size of the message wire representation.
|
![]() ![]() | CreateFromBytes |
Create a message from specified byte array
|
![]() | Equals | (Inherited from Object.) |
![]() | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | GetAllowCallbackInClose | Obsolete.
Deprecated, use Tibems.GetAllowCloseInCallback instead.
|
![]() ![]() | GetAllowCloseInCallback |
Determine whether client callbacks may call close methods
|
![]() ![]() | GetAsBytes |
Return a copy of the message data as a byte array, suitable for archiving in a file
|
![]() ![]() | GetConnectAttempts |
Returns the connect attempts setting.
|
![]() ![]() | GetConnectAttemptTimeout |
Returns the connect attempt timeout value
|
![]() ![]() | GetConnectionActiveURL | Return the URL of the EMS server for the specified connection. |
![]() ![]() | GetEncoding |
Return the name of the global string encoding for messages
|
![]() ![]() | GetExceptionOnFTSwitch |
Return the fault tolerance exception setting
|
![]() | GetHashCode | Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
![]() ![]() | GetMessageBodySize |
Returns the total wire size of the message body for a message
which was received or sent.
|
![]() ![]() | GetMessageEncoding |
Return string encoding name set for this message
|
![]() ![]() | GetMessageHeadersSize |
Returns the total wire size of the message headers for a message
which was received or sent.
|
![]() ![]() | GetMessagePropertiesSize |
Returns the total wire size of the message properties for a message
which was received or sent.
|
![]() ![]() | GetMessageSize |
Returns the total wire size of the message which was received or sent
|
![]() ![]() | GetMulticastDaemon |
Get the port on which the EMS client will connect to the multicast
daemon.
|
![]() ![]() | GetMulticastEnabled |
Get whether MessageConsumers subscribed to a multicast-enabled topic
will receive messages over multicast.
|
![]() ![]() | GetNPSendCheckMode |
Return mode defining when a producer checks the result of sending
a NON_PERSISTENT message.
|
![]() ![]() | GetPingInterval |
Return the ping interval in seconds used by inactive connections
|
![]() ![]() | GetProperty | Retrieve the property value given the property name |
![]() ![]() | GetReconnectAttempts | Returns the reconnect attempts setting. |
![]() ![]() | GetReconnectAttemptTimeout |
Returns the connect attempt timeout value
|
![]() ![]() | GetSessionDispatcherDaemon | Return the dispatcher thread setting. |
![]() ![]() | GetSocketReceiveBufferSize |
Returns the size of socket receive buffer.
|
![]() ![]() | GetSocketSendBufferSize |
Return the size of socket send buffer |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() ![]() | IsConsumerMulticast |
Checks if a MessageConsumer is receiving messages over multicast.
|
![]() ![]() | MakeWriteable |
Set message to writeable state without resetting its content.
|
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() ![]() | RecoverMsg |
Recover a single message.
|
![]() ![]() | SetAllowCallbackInClose | Obsolete.
Deprecated, use Tibems.SetAllowCloseInCallback instead.
|
![]() ![]() | SetAllowCloseInCallback |
Sets if Close
methods can be called in the IMessageListener callback.
|
![]() ![]() | SetConnectAttempts |
Modify the connection attempts setting determining the number of
attempts the client makes to connect to the server.
|
![]() ![]() | SetConnectAttemptTimeout | Set the maximum amount of time a client will
wait for the connection to be established
|
![]() ![]() | SetEncoding |
Set global string encoding for messages
|
![]() ![]() | SetExceptionOnFTSwitch |
Sets if ExceptionListener set on the Connection should be called after
fault-tolerant switch.
|
![]() ![]() | SetMessageEncoding |
Set the character encoding for an individual message
|
![]() ![]() | SetMulticastDaemon |
Set the port on which the EMS client will connect to the multicast
daemon.
|
![]() ![]() | SetMulticastEnabled |
Set whether MessageConsumers subscribed to a multicast-enabled topic
will receive messages over multicast. |
![]() ![]() | SetNPSendCheckMode |
Set mode defining when a producer should check the result of sending
a NON_PERSISTENT message.
|
![]() ![]() | SetPingInterval |
Set the interval at which the client tests network connectivity
|
![]() ![]() | SetProperty | Modify a property value |
![]() ![]() | SetReconnectAttempts |
Sets the parameter for the number of attempts the connections
make to reconnect to the backup server during fault-tolerant switch.
|
![]() ![]() | SetReconnectAttemptTimeout | Sets the maximum amount of time a client will wait for
the reconnect to complete |
![]() ![]() | SetSessionDispatcherDaemon | Set the dispatcher thread setting |
![]() ![]() | SetSocketReceiveBufferSize | Set the size of socket receive buffers |
![]() ![]() | SetSocketSendBufferSize | Set the size of socket send buffers |
![]() ![]() | SetTraceFile |
Use this method to instruct the TIBCO EMS Client library to direct
the tracing, that would normally go to stderr or stdout, to a file named
fileName.
|
![]() | ToString | (Inherited from Object.) |
Fields
Name | Description | |
---|---|---|
![]() ![]() | DEFAULT_FACTORY_PASSWORD |
Defines the name of the ConnectionFactory property specifying
default user password set for Connections created by the factory
|
![]() ![]() | DEFAULT_FACTORY_USERNAME |
Defines the name of the ConnectionFactory property specifying
default user name set for Connections created by the factory
|
![]() ![]() | FACTORY_CONNECT_ATTEMPT_COUNT |
Defines the name of the ConnectionFactory property specifying
the maximum iterations a client program will go through its URL list
until it establishes its first connection to an EMS server.
|
![]() ![]() | FACTORY_CONNECT_ATTEMPT_DELAY |
Defines the name of the ConnectionFactory property specifying the
interval between iterations a client program will try to establishe
its first connection to an EMS server.
|
![]() ![]() | FACTORY_CONNECT_ATTEMPT_TIMEOUT |
Defines the name of the ConnectionFactory property specifying
the maximum amount of time a client program will wait for the
connection to be established to an EMS server
This property is defined as String "TIBCO.EMS.connect.attempttimeout".
|
![]() ![]() | FACTORY_LOAD_BALANCE_METRIC |
Defines the name of the ConnectionFactory property specifying
the load balancing metric to be used by the factory.
|
![]() ![]() | FACTORY_LOAD_BALANCE_METRIC_BYTE_RATE |
Indicates that the connection factory load balances connections across
multiple servers by creating a connection to the server with the lowest
total byte rate (input and output).
|
![]() ![]() | FACTORY_LOAD_BALANCE_METRIC_CONNECTIONS |
Indicates that the connection factory load balances connections across
multiple servers by creating a connection to the server with the fewest
number of connections.
|
![]() ![]() | FACTORY_LOAD_BALANCE_METRIC_NONE |
Indicates that no load balancing metric has been set for the connection
factory.
|
![]() ![]() | FACTORY_MULTICAST_DAEMON |
Defines the name of the ConnectionFactory property specifying
the port of the multicast daemon used by MessageConsumers subscribed
to multicast-enabled topics.
This property is defined as String "TIBCO.EMS.multicast.daemon".
|
![]() ![]() | FACTORY_MULTICAST_ENABLED |
Defines the name of the ConnectionFactory property specifying
whether MessageConsumers subscribed to a multicast-enabled topic
are to receive messages over multicast or unicast.
This property is defined as String "TIBCO.EMS.multicast.enabled".
|
![]() ![]() | FACTORY_RECONNECT_ATTEMPT_COUNT |
Defines the name of the ConnectionFactory property specifying
the maximum iterations a client program will try to re-establish
a connection to an EMS server after losing previous connection.
|
![]() ![]() | FACTORY_RECONNECT_ATTEMPT_DELAY |
Defines the name of the ConnectionFactory property specifying
the interval between reconnection attempts.
|
![]() ![]() | FACTORY_RECONNECT_ATTEMPT_TIMEOUT |
Defines the name of the ConnectionFactory property specifying
the maximum amount of time a client program will wait for the
connection to be re-established to an EMS server
This property is defined as String "TIBCO.EMS.reconnect.attempttimeout".
|
![]() ![]() | JMS_TIBCO_CM_PUBLISHER |
Provider-specific message property which may be set if imported message
has been published by TIBCO Rendezvous Certified Messaging application.
|
![]() ![]() | JMS_TIBCO_CM_SEQUENCE |
Provider-specific message property which may be set if imported message
has been published by TIBCO Rendezvous Certified Messaging application.
|
![]() ![]() | JMS_TIBCO_COMPRESS |
Provider-specific message property which is set by the
application if this message should be compressed before
it is sent to the server. |
![]() ![]() | JMS_TIBCO_DISABLE_SENDER |
Provider specific message property which may be set to prevent the server
from including the user name into message when sending this message to
consumers.
|
![]() ![]() | JMS_TIBCO_IMPORTED |
Provider-specific message property which is set by the provider if the
message has been imported from an external message service, such as TIBCO
Rendezvous or TIBCO SmartSockets.
|
![]() ![]() | JMS_TIBCO_MSG_EXT |
Provider-specific message property which is set by the provider
or the application when message extensions are used.
|
![]() ![]() | JMS_TIBCO_MSG_TRACE |
Provider-specific message property which is set by the provider
or the application when message extensions are used.
|
![]() ![]() | JMS_TIBCO_PRESERVE_UNDELIVERED |
Provider-specific message property which is set by the
application if this message should be placed into special
system queue in case it could not be delivered.
|
![]() ![]() | JMS_TIBCO_SENDER |
Provider-specific message property which may be set in a received message if
message has been sent on a destination with sender name property.
When set in the message, the property value is a String specifying
the name of the user who sent this message.
|
![]() ![]() | JMS_TIBCO_SS_SENDER |
Provider-specific message property which is set if imported message
has been published by TIBCO SmartSockets application.
|
![]() ![]() | NPSEND_CHECK_ALWAYS |
Defines mode when producer always checks result of sending a
NON_PERSISTENT message. See SetNPSendCheckMode(MessageProducer, Int32).
|
![]() ![]() | NPSEND_CHECK_AUTH |
Defines mode when producer checks result of sending a NON_PERSISTENT message
only when server authorization is enabled. See SetNPSendCheckMode(MessageProducer, Int32).
|
![]() ![]() | NPSEND_CHECK_DEFAULT |
Defines default check mode for sending a NON_PERSISTENT messages.
See SetNPSendCheckMode(MessageProducer, Int32).
|
![]() ![]() | NPSEND_CHECK_NEVER |
Defines mode when producer never checks result of sending a
NON_PERSISTENT message. See SetNPSendCheckMode(MessageProducer, Int32).
|
![]() ![]() | NPSEND_CHECK_TEMP_AUTH |
Defines mode when producer checks result of sending a NON_PERSISTENT message
when sending into temporary destination or if server authorization is enabled.
See SetNPSendCheckMode(MessageProducer, Int32).
|
![]() ![]() | NPSEND_CHECK_TEMP_DEST |
Defines mode when producer checks result of sending a NON_PERSISTENT message
only when sending into temporary destination. See SetNPSendCheckMode(MessageProducer, Int32).
|
![]() ![]() | PROP_CLOSE_IN_CALLBACK |
Defines the name of the provider property controlling if a
MessageConsumer.close(), Session.close() or Connection.close()
methods can be called in the MessageListener callback.
|
![]() ![]() | PROP_CONNECT_ATTEMPT_TIMEOUT |
Defines the name of the System Property controlling the
maximum time for the connections to connect to the server.
When too many clients connect to the same server, the server may not
be able to accept all connections at the same time or may run out of
system resources. This parameter specifies the amount of time a client
is willing to wait for a connection to be established.
Internally the client library will tear down any hung connections (either
because of non-availiblity of system resources or some other EMS server
problem) after this timeout.
The value of this property in an integer and is in seconds.
This property is defined as String "tibco.tibjms.connect.attempt.timeout".
|
![]() ![]() | PROP_CONNECT_ATTEMPTS |
Defines the name of the provider property controlling the
number of attempts the connections make to connect to the server.
|
![]() ![]() | PROP_DAEMON_DISPATCHER |
Defines the name of the provider property controlling the type of
Session dispatcher threads
|
![]() ![]() | PROP_FT_SWITCH_EXCEPTION |
Defines the name of the provider property controlling if ExceptionListener
set on the Connection should be called during fault-tolerant switch.
|
![]() ![]() | PROP_MESSAGE_ENCODING |
Defines the name of the System Property setting the global encoding
name for String values in the message properties and data fields.
|
![]() ![]() | PROP_MULTICAST_DAEMON |
Defines the name of the System Property specifying the port on which
EMS clients will connect to the multicast daemon.
This property is defined as String "tibco.tibjms.multicast.daemon".
|
![]() ![]() | PROP_MULTICAST_ENABLED |
Defines the name of the System Property specifying whether multicast
is enabled or disabled for this EMS client.
This property is defined as String "tibco.tibjms.multicast.enabled".
|
![]() ![]() | PROP_PING_INTERVAL |
Defines the name of the System Property setting the ping interval
for inactive connections. |
![]() ![]() | PROP_RECONNECT_ATTEMPT_TIMEOUT |
Defines the name of the System Property controlling the
maximum time for connections to reconnect to the backup
server during the fault-tolerant switch. This property is similar to
PROP_CONNECT_ATTEMPTS_TIMEOUT. The difference is that it may be necessary
to use different parameters during reconnect than during the initial
connect. Initial connect of the clients to the server is normally
distributed in time and there are less chances of the server exceeding its
maximum accept queue. During fault-tolerant switch, all connected clients
automatically try to reconnect to the backup server, approximately at
the same time. When the number of connections is large, it may require
more reconnect time to reconnect than the initial connect. The value
of this property is an integer in seconds.
This property is defined as String "tibco.tibjms.reconnect.attempt.timeout".
|
![]() ![]() | PROP_RECONNECT_ATTEMPTS |
Defines the name of the provider property controlling the
number of attempt the connections make to reconnect to the backup
server during the fault-tolerant switch.
|
![]() ![]() | PROP_SOCKET_RECEIVE |
Defines the name of the provider property setting the size of
the socket receive buffer size in kilobytes for client connections.
|
![]() ![]() | PROP_SOCKET_SEND |
Defines the name of the provider property setting the size of
the socket send buffer size in kilobytes for client connections.
|
Events
Name | Description | |
---|---|---|
![]() ![]() | MulticastExceptionHandler | The multicast exception event handler |