tibrvTransport_WaitForVcConnection()

Function

Declaration

tibrv_status tibrvTransport_WaitForVcConnection(
    tibrvTransport    vcTransport,
    tibrv_f64         timeout);

Purpose

Test the connection status of a virtual circuit.

Remarks

This function produces the same information as the virtual circuit advisory messages—but it produces it synchronously (while advisories are asynchronous). Programs can use this function not only to test the connection, but also to block until the connection is ready to use.

For example, a program can create a terminal object, then call this function to wait until the connection completes.

Parameter

Description

vcTransport

Wait until this virtual circuit transport object has established a connection with its opposite terminal. You may supply either an accept terminal or a connect terminal as an argument.

timeout

This parameter determines the behavior of the call:

•

For a quick test of current connection status, supply zero. The call returns immediately, without blocking.

•

To wait for a new terminal to establish a connection, supply a reasonable positive value. The call returns either when the connection is complete, or when this time limit elapses.

•

To wait indefinitely for a usable connection, supply -1. The call returns when the connection is complete. If the connection was already complete and is now broken, the call returns immediately.


Status	Description
TIBRV_OK	The connection is complete (ready to use).
TIBRV_TIMEOUT	The connection is not yet complete, but the non-negative time limit for waiting has expired.
TIBRV_VC_NOT_CONNECTED	The connection was formerly complete, but is now irreparably broken.

tibrvTransport_WaitForVcConnection()

Declaration

Purpose

Remarks

See Also