tibemsConnection_Stop

Purpose

Stop delivering inbound messages.

C Declaration

tibems_status tibemsConnection_Stop(
    tibemsConnection connection );

COBOL Call

CALL "tibemsConnection_Stop"
     USING BY VALUE connection,
           RETURNING tibems-status
END-CALL.

Parameters

Remarks

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

When a connection is created, it is stopped. It does not deliver inbound messages until the program calls this function 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 functions 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 function, all facilities of the connection and its sessions remain available to those listeners until they return. In the meantime, this function 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

tibemsConnection_Start