VCTransport.WaitForVCConnection

Method

Visual Basic

Public Sub WaitForVCConnection(
    ByVal timeout As Double )
  As VCTransport

C#

public void WaitForVCConnection(
    double timeout );

Purpose

Test the connection status of a virtual circuit.

Remarks

This method tests (and can block) until this virtual circuit transport object has established a connection with its opposite terminal. You may call this method for either an accept terminal or a connect terminal.

This method produces the same information as the virtual circuit advisory messages—but it produces it synchronously (while advisories are asynchronous). Programs can use this method 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 method to wait until the connection completes.

Parameter

Description

timeout

This parameter determines the behavior of the call:

•

For a quick test of current connection status, supply TimeoutValue.NoWait. 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 TimeoutValue.WaitForever. The call returns when the connection is complete. If the connection was already complete and is now broken, the call returns immediately.

Results

When the connection is complete (ready to use), this method returns normally. Otherwise it throws an exception; the status value in the exception yields additional information about the unusable connection.


Status	Description
Timeout	The connection is not yet complete, but the non-negative time limit for waiting has expired.
VCNotConnected	The connection was formerly complete, but is now irreparably broken.

VCTransport.WaitForVCConnection

Visual Basic

C#

Purpose

Remarks

Results

See Also