IConnection

Interface:

String ClientID
      {
        get;
        set;
      }

Get and set the client identifier for the connection.

The client identifier can either be preconfigured by the administrator in a ConnectionFactory, or assigned by setting ClientID.

A client identifier is used only to support durable subscriptions in the publish/subscribe domain, and is ignored in the point-to-point domain.

If an application sets a client identifier for a connection, the application must do so immediately after creating the connection, and before performing any other operation on the connection. If the application tries to set a client identifier after this point, the call throws exception IllegalStateException.

This property is not valid for a real-time connection to a broker.

Exceptions:

• XMSException
• IllegalStateException
• InvalidClientIDException

Interface:

	ExceptionListener ExceptionListener
        {
          get;
          set;
        }

Get the exception listener that is registered with the connection, and register an exception listener with the connection.

If no exception listener is registered with the connection, the method returns null. If an exception listener is already registered with the connection, you can cancel the registration by specifying a null instead of the exception listener.

For more information about using exception listeners, see Using message and exception listeners in .NET.

Exceptions:

• XMSException

Interface:

IConnectionMetaData MetaData
    {
      get;
    }

Get the metadata for the connection.

Exceptions:

• XMSException

Interface:

void  Close();

Close the connection.

If an application tries to close a connection that is already closed, the call is ignored.

Parameters:

None

Returns:

Void

Exceptions:

• XMSException

Interface:

	ISession CreateSession(Boolean transacted, 
                         AcknowledgeMode acknowledgeMode);

Create a session.

Parameters:

transacted (input)

The value True means that the session is transacted. The value False means that the session is not transacted.

For a real-time connection to a broker, the value must be False.

acknowledgeMode (input)

Indicates that how messages received by an application are acknowledged. The value must be one of the following from the AcknowledgeMode enumerator:

• AcknowledgeMode.AutoAcknowledge
• AcknowledgeMode.ClientAcknowledge
• AcknowledgeMode.DupsOkAcknowledge

For a real-time connection to a broker, the value must be AcknowledgeMode.AutoAcknowledge or AcknowledgeMode.DupsOkAcknowledge

This parameter is ignored if the session is transacted. For more information about acknowledgment modes, see Message acknowledgment.

Returns:

The Session object

Exceptions:

• XMSException

Interface:

void  Start();

Start or restart the delivery of incoming messages for the connection. The call is ignored if the connection is already started.

Parameters:

None

Returns:

Void

Exceptions:

• XMSException

Interface:

void  Stop();

Stop the delivery of incoming messages for the connection. The call is ignored if the connection is already stopped.

Parameters:

None

Returns:

Void

Exceptions:

• XMSException