Click this button to go to the index for this section. |
t_getstate(3)
NAME
t_getstate - Gets the current state of the transport providerLIBRARY
XTI Library (libxti.a)SYNOPSIS
#include <xti.h> int t_getstate( int fd) ;STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: t_getstate: XPG4-UNIX Refer to the standards(5) reference page for more information about industry standards and associated tags.PARAMETERS
The following table summarizes the relevance of input parameter data before and after the t_getstate() function is called: Parameter Before Call After Call ____________________________________ fd y n Notes to Table: y This is a meaningful parameter. n This is not a meaningful parameter. fd Specifies a file descriptor returned by the t_open() function that identifies the local transport endpoint.VALID STATES
The t_getstate() function can be called in all transport provider states except T_UNINIT.DESCRIPTION
The t_getstate() function is a general utility function used to get the current state of the transport provider. The transport endpoint, which is specified by a file descriptor, is regarded as a finite-state machine that may be in any one of eight states. When the t_getstate() function is executed, the current state of the transport endpoint is returned.NOTES
If the transport provider is undergoing a change in state when t_getinfo() is called, a failure occurs.RETURN VALUE
Upon successful completion, the transport endpoint state is returned. Otherwise, a value of -1 is returned and t_errno is set to indicate the error. The current state is one of the following: [T_UNBND] Address not bound to transport endpoint. [T_IDLE] The transport endpoint is inactive. [T_OUTCON] Outgoing connection pending. [T_INCON] Incoming connection pending. [T_DATAXFER] Data transfer in progress. [T_OUTREL] Outgoing orderly release (waiting for an orderly release indication). [T_INREL] Incoming orderly release (waiting to send an orderly release request).ERRORS
If the t_getstate() function fails, t_errno may be set to one of the following values: [TBADF] The specified file descriptor does not refer to a transport endpoint. This error may be returned when the endpoint referenced by the fd parameter has been previously closed or an erroneous file descriptor value has been provided. [TPROTO] This error indicates that a communication problem has been detected between XTI and the transport provider for which there is no other suitable XTI(t_errno). [TSTATECHNG] The transport provider is undergoing a change in state. [TSYSERR] A system error occurred during execution of this function.RELATED INFORMATION
Function: t_open(3).