Collapse All Expand All

.NET Framework Class Library
Connection Class See Also

[TIBCO.EMS .NET client library 6.1 documentation]

Temporarily stops a connection's delivery of incoming messages.

Namespace: TIBCO.EMS
Assembly: TIBCO.EMS (in TIBCO.EMS.dll)

# Syntax

    public virtual void Stop()

    Public Overridable Sub Stop

    public:
    virtual void Stop()

# Remarks

This call temporarily stops the connection from delivering inbound messages. A program can restart delivery by calling Start()()().

When a connection is created, it is stopped. It does not deliver inbound messages until the program calls this method to explicitly start it.

If the connection is already stopped, this call has no effect.

Effect

When this call returns, the connection has stopped delivery to all consumers associated with the connection:

- Messages do not arrive to trigger asynchronous message handler events, nor message listeners.
- Synchronous receive methods block. If their timeout intervals expire, they return null.

Blocking

If any message listener or receive call associated with the connection is processing a message when the program calls this method, all facilities of the connection and its sessions remain available to those listeners until they return. In the meantime, this method blocks until that processing completes—that is, until all message listeners and receive calls have returned.

However, the stopped connection prevents the client program from processing any new messages.

Sending

A stopped connection can still send outbound messages.

# See Also

Connection Class
TIBCO.EMS Namespace