NAME

t_rcvudata - receive a data unit

SYNOPSIS

#include <xti.h>

int t_rcvudata(int fd, struct t_unitdata *unitdata, int *flags);

DESCRIPTION

Parameters	Before call	After call
fd	x	/
unitdata->addr.maxlen	x	=
unitdata->addr.len	/	x
unitdata->addr.buf	?	(?)
unitdata->opt.maxlen	x	=
unitdata->opt.len	/	x
unitdata->opt.buf	?	(?)
unitdata->udata.maxlen	x	=
unitdata->udata.len	/	x
unitdata->udata.buf	?	(?)
flags	/	x

This function is used in connectionless-mode to receive a data unit from another transport user. The argument fd identifies the local transport endpoint through which data will be received, unitdata holds information associated with the received data unit, iovcount contains the number of non-contiguous udata buffers and is greater than zero and limited to an implementation-defined value given by T_IOV_MAX which is at least 16, and flags is set on return to indicate that the complete data unit was not received. If the limit on iovcount is exceeded or iovcount is zero, the function fails with [TBADDATA]. The argument unitdata points to a t_unitdata structure containing the following members:

 

struct netbuf addr;
struct netbuf opt;
struct netbuf udata;

The maxlen field of addr, opt and udata must be set before calling this function to indicate the maximum size of the buffer for each. If the maxlen field of addr or opt is set to zero, no information is returned in the buf field of this parameter.

On return from this call, addr specifies the protocol address of the sending user, opt identifies options that were associated with this data unit, and udata specifies the user data that was received.

By default, t_rcvudata() operates in synchronous mode and will wait for a data unit to arrive if none is currently available. However, if O_NONBLOCK is set (via t_open() or fcntl()), t_rcvudata() will execute in asynchronous mode and will fail if no data units are available.

If the buffer defined in the udata field of unitdata is not large enough to hold the current data unit, the buffer will be filled and T_MORE will be set in flags on return to indicate that another t_rcvudata() should be called to retrieve the rest of the data unit. Subsequent calls to t_rcvudata() will return zero for the length of the address and options until the full data unit has been received.

If the call is interrupted, t_rcvudata() will return [EINTR] and no datagrams will have been removed from the endpoint.

VALID STATES

T_IDLE

ERRORS

On failure, t_errno is set to one of the following:

[TBADDATA]

iovcount is zero or greater than T_IOV_MAX.

[TBADF]

The specified file descriptor does not refer to a transport endpoint.

[TBUFOVFLW]

The number of bytes allocated for the incoming protocol address or options (maxlen) is greater than 0 but not sufficient to store the information. The unit data information to be returned in unitdata will be discarded.

[TLOOK]

An asynchronous event has occurred on this transport endpoint and requires immediate attention.

[TNODATA]

O_NONBLOCK was set, but no data units are currently available from the transport provider.

[TNOTSUPPORT]

This function is not supported by the underlying transport provider.

[TOUTSTATE]

The communications endpoint referenced by fd is not in one of the states in which a call to this function is valid.

[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 error (t_errno).

[TSYSERR]

A system error has occurred during execution of this function.

RETURN VALUE

Upon successful completion, a value of 0 is returned. Otherwise, a value of -1 is returned and t_errno is set to indicate an error.

SEE ALSO

fcntl(), t_alloc(), t_open(), t_rcvuderr(), t_sndudata().

CHANGE HISTORY

Issue 4

The SYNOPSIS section is placed in the form of a standard C function prototype.