'\" rtp.\" -*- nroff -*- vim: ft=nroff.\".\" @(#) t_rcvudata.3,v 1.1.4.1 2004/01/12 23:32:52 brian Exp.\".\" =========================================================================.\".\" Copyright (C) 2001-2004  OpenSS7 Corporation <www.openss7.com>.\".\" All Rights Reserved..\".\" Permission is granted to make and distribute verbatim copies of this.\" manual provided the copyright notice and this permission notice are.\" preserved on all copies..\".\" Permission is granted to copy and distribute modified versions of this.\" manual under the conditions for verbatim copying, provided that the.\" entire resulting derived work is distributed under the terms of a.\" permission notice identical to this one.\" .\" Since the Linux kernel and libraries are constantly changing, this.\" manual page may be incorrect or out-of-date.  The author(s) assume no.\" responsibility for errors or omissions, or for damages resulting from.\" the use of the information contained herein.  The author(s) may not.\" have taken the same level of care in the production of this manual,.\" which is licensed free of charge, as they might when working.\" professionally..\" .\" Formatted or processed versions of this manual, if unaccompanied by.\" the source, must acknowledge the copyright and authors of this work..\".\" -------------------------------------------------------------------------.\".\" U.S. GOVERNMENT RESTRICTED RIGHTS.  If you are licensing this Software.\" on behalf of the U.S. Government ("Government"), the following.\" provisions apply to you.  If the Software is supplied by the Department.\" of Defense ("DoD"), it is classified as "Commercial Computer Software".\" under paragraph 252.227-7014 of the DoD Supplement to the Federal.\" Acquisition Regulations ("DFARS") (or any successor regulations) and the.\" Government is acquiring only the license rights granted herein (the.\" license rights customarily provided to non-Government users).  If the.\" Software is supplied to any unit or agency of the Government other than.\" DoD, it is classified as "Restricted Computer Software" and the.\" Government's rights in the Software are defined in paragraph 52.227-19.\" of the Federal Acquisition Regulations ("FAR") (or any success.\" regulations) or, in the cases of NASA, in paragraph 18.52.227-86 of the.\" NASA Supplement to the FAR (or any successor regulations)..\".\" =========================================================================.\" .\" Commercial licensing and support of this software is available from.\" OpenSS7 Corporation at a fee.  See http://www.openss7.com/.\" .\" =========================================================================.\".\" Last Modified 2004/01/12 23:32:52 by brian.\".\" =========================================================================.so lis.macros.R1bracket-label "\fR[\fB" "\fR]" "\fR, \fB"no-default-databasedatabase lis.refsaccumulatemove-punctuationabbreviate Ajoin-authors ", " ", " " and "et-al " et al" 2 3abbreviate-label-ranges ".."sort-adjacent-labels.R2.\".\".\".\".TH T_RCVUDATA 3 "2004/01/12 23:32:52" "LiS-2_16_18-8" "Linux Fast-STREAMS XTI Library".\".\".SH NAME.B t_rcvudata\- receive unitdata.\".\".SH SYNOPSIS.PP.B #include <xti.h>.HP 8.BI "int t_rcvudata(int " fd ", struct t_unitdata *" data ", int *" flags );.\".\".SH ARGUMENTS.PP.TP 12.I fdthe transport enpoint upon which to receive unit data..TP.I dataa pointer to a.B t_unitdatastructure to contain information about the received unit data..TP.I flagsa pointer to an.B intto contain flags concerning the received unit data..\".\".SH DESCRIPTION.PP.BR t_rcvudata ()received unitdata message arriving on the local transport endpoint specifiedby.IR fd ..PP.I fdspecifies the local transport endpoint upon which the unitdata messages are tobe reecived..PP.I datais a pointer to a.BR t_unitdata ()structure that returns the received unitdata message, options and originatingtransport address..PP.I flagsprovides information about the received data on return.  Flags returned by.BR t_rcvudata ()can be a bitwise OR of any of the following flags:.TP 12.B T_MOREindicates that a subsequent receive operation is necessary to receive theremainder of the data belonging to the same transport service data unit..PPThe.BR t_unitdata ()structure is formatted as follows:.sp.nf\fC\s-1\struct t_unitdata {        struct netbuf addr;             /* address */        struct netbuf opt;              /* options */        struct netbuf udata;            /* user data */};\fR\s+1.fi.PPThe.BR t_unitdata ()structure returns the following members and information:.TP 12.I addris a.BR netbuf (3)structure that returns the originating transport address of the receivedunitdata message.The.I data->addr.maxlenis significant on call and the.I data->addr.lenis significant on return.If.I data->addr.maxlenis zero on call, no originating transport address will be returned.If.I data->addr.lenis zero on return, not originating transport address was available with theunitdata indication..TP 12.I optis a.BR netbuf (3)structure that returns the options associated with the received unitdatamessage.The.I data->opt.maxlenis significant on call and the.I data->opt.lenis significant on return.If.I data->opt.maxlenis zero on call, no originating transport options will be returned.If.I data->opt.lenis zero on return, no originating transport options were available with theunitdata indication..TP 12.I udatais a.BR netbuf (3)structure that returns the received unitdata message.The.I data->udata.maxlenis significant on call and the.I data->udata.lenis significant on return.If.I data->udata.maxlenis zero on call, no originating data will be returned.If.I data->udata.lenis zero on return, no originating data was available with the unitdataindication..\".\".SH CAVEATS.PP.BR t_rcvudata ()is only valid in state.BR T_IDLE ..PP.BR t_rcvudata ()is only valid for transport service providers of service type.BR T_CLTS ..PPIn synchronous mode,.BR t_rcvudata ()will block until a unitdata indication arrives on.IR fd .In asynchronous mode where the is no unitdata indication immediatelyavailable,.BR t_rcvudata ()will fail, return -1 and set.IR t_errno (3)to.RB [ TNODATA ]..\".\".SH "RETURN VALUE".PPUpon success,.BR t_rcvudata ()returns zero (0).Upon failure,.BR t_rcvudata ()returns -1 and sets.IR t_errno (3)to an appropriate error number..\".\".SH ERRORS.PPWhen.BR t_rcvudata ()fails, it returns -1 and sets.IR t_errno (3)to an appropriate error number as follows:.\".TP 12.\".RB [ TBADDATA ].\"The amount of data specified for the call and underlying transport service.\"provider was invalid (i.e. was outside the protocol limits).  See.\".BR t_getinfo (3).\"and.\".BR t_open (3).\"for more information..TP 12.RB [ TBADF ].I fdis invalid..TP 12.RB [ TBUFOVFLW ]The.I maxlenfield of a.BR netbuf (3)structure.IR "" ( addr " or " opt )passed to the call wasnon-zero, but insufficient to hold the available information.  See,.BR netbuf (3)for more information..TP 12.RB [ TLOOK ]An asynchronous event occured before the call could complete.  See.BR t_look (3)for more information..TP 12.RB [ TNODATA ]An attempt was made to read data but no data indication was available and.I fdwas in asynchronous mode.BR "" ( O_NONBLOCK " or " O_NDELAY " was set with " t_open "(3) or " fcntl (2))..TP 12.RB [ TNOTSUPPORT ]The call requires the use of a TLI primitive not supported by the underlying transport provider.This can occur when the transport service provider was of service type.BR T_COTS " or " T_COTS_ORD ..TP 12.RB [ TOUTSTATE ]The call was issued with the interface in a state other than.BR T_IDLE ..TP 12.RB [ TPROTO ]A protocol error occured between the XTI library and the underlying transport provider..TP 12.RB [ TSYSERR ]A.B Linuxsystem error occured and the.B Linuxerror number is set in.IR errno (3)..\".\".SH "SEE ALSO".PP.BR errno (3),.BR fcntl (2),.BR netbuf (3),.BR t_errno (3),.BR t_getinfo (3),.BR t_look (3),.BR t_open (3)..\".\".SH "BUGS".PP.BR t_rcvudata ()has no known bugs..BR t_rcvudata ()has been tested for the described behavior using the.I /usr/bin/test-xnetconformance test program..\".\".SH "CONFORMING TO".PPXTI/TLI,.[XTI.]TPI,.[TPI Revision 2.0.0.]XPG5,XNS 5.2,.[xns.]SUSv2..[susv2.].\".\".[$LIST$.].TI