SmartSockets .NET Class Library

TipcConnClient.getTimeout Method 

Get a timeout value.

There are several timeout properties associated with a connection: TIMEOUT_READ, TIMEOUT_WRITE, TIMEOUT_KEEP_ALIVE, and TIMEOUT_DELIVERY, all of which are used to check for network failures. This method allows the values of these timeout properties to be inspected. All timeout values are in seconds.

The TIMEOUT_READ property specifies the length of time that no data is read on the connection before a keep alive message is exchanged with remote end. If this is set to 0.0, the connection will block forever waiting for data to arrive and no keep alives will be generated.

The TIMEOUT_KEEP_ALIVE property is the length of time the client will wait for a reply to a keep alive request. If this timeout expires, the error callback will be called with a timeout error code.

The TIMEOUT_DELIVERY property is the length of time the client will wait for an ack to arrive for amessage sent with GMD. If this expires, a GMD_FAILURE message will be generated and processed by the client.

The TIMEOUT_WRITE property is not implemented in this release.

public virtual double getTimeout(
   int timeout_type
);

Parameters

timeout_type
the type of timeout.

Return Value

The requested timeout, as a second-based double.

Exceptions

Exception TypeCondition
TipcBadArgumentException If timeout_type is not one of the allowed values.

See Also

TipcConnClient Class | TipcConnClient Members | TIBCO.SMARTSOCKETS Namespace | setTimeout


Copyright © TIBCO Software Inc. All rights reserved