'\" rtp.\" -*- nroff -*- vim: ft=nroff.\".\" @(#) t_rcvv.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_RCVV 3 "2004/01/12 23:32:52" "LiS-2_16_18-8" "Linux Fast-STREAMS XTI Library".\".\".SH NAME.B t_rcvv\- receive data and scatter.\".\".SH SYNOPSIS.PP.B #include <xti.h>.HP 8.BI "int t_rcvv(int " fd ", struct t_iovec *" iov ", unsigned int " iovcnt ", int *" flags );.\".\".SH ARGUMENTS.PP.TP 12.I fdthe transport endpoint upon which to receive scatter-gather data..TP.I iova pointer to a.B t_iovecstructure containing a scatter-gather array into which to receive the data..TP.I iovcnta count of the number of buffer vectors in the array..TP.I flagsa pointer to an.I intto contain the received data flags..\".\".SH DESCRIPTION.PP.BR t_rcvv ()receives connection oriented data and scatters the data into a vector ofbuffers..PP.I fdspecifies the local transport endpoint upon which the data arrives..PP.I iovis a pointer to an array of.B t_iovecstructures that describes the buffers to which the received data is to bescattered..PP.I iovcntis a count of the total number of buffers in the buffer array..PP.I flagsare flags returned describing the received data.  Flags returned by.BR t_rcvv ()can be a bitwise OR of the following flags:.TP 12.B T_MOREindicates on return that a subsequent receive operation is necessary toreceive the remainder of the data belonging to the same transport service dataunit..TP 12.B T_EXPEDITEDindicates on return that the received data was expedited data..PPThe.B t_iovecstructure is formatted as follows:.sp.nf\fC\s-1\struct t_iovec {        void *iov_base;        size_t iov_len;};\fR\s+1.fi.PPThe.B t_iovecstructure specifies the following members:.TP 12.I iov_baseThe base of the buffer..TP 12.I iov_lenThe length of the buffer..PPWhen data is received, each buffer in the array of buffers.I iovare used in order until they are filled and then data is filled into tthe next sequential buffer inthe array..\".\".SH CAVEATS.PP.BR t_rcvv ()is only valid in the.BR T_DATAXFER " or " T_OUTRELstates..PP.BR t_rcvv ()is only valid for transport service providers of service type.BR T_COTS " or " T_COTS_ORD ..PPIn synchronous mode,.BR t_rcvv ()blocks until a data indication is available.  In asynchronous mode when thereis no data indication immediately available,.BR t_rcvv ()fails, returns -1 and sets.IR t_errno (3)to.RB [ TNODATA ]..PPPortions of a transport service data unit can be interleaved with portions ofan expedited transport service data unit..PPIf the.I tsdufield of the.B t_infostructure returned by.BR t_open "(3) or " t_getinfo (3)is.BR T_INVALID ,then the flag.B T_MOREhas no meaning for normal data received with.BR t_rcvv ().If the.I etsdufield of the.B t_infostructure returned by.BR t_open "(3) or " t_getinfo (3)is.BR T_INVALID ,then the flag.B T_MOREhas no meaning for expedited data received with.BR t_rcvv ()..PP.BR t_rcvv ()is functionally equivalent to.BR readv (2)and the two functions can be used interchangeably;however,.BR readv (2)does not maintain.IR t_errno (3)..\".\".SH "RETURN VALUE".PPUpon success,.BR t_rcvv ()returns zero (0) or a positive integer reflecting the number of bytes ofreceived data written into the scatter buffers.Upon failure,.BR t_rcvv ()returns -1 and sets.IR t_errno (3)to an appropriate error number..\".\".SH ERRORS.PPWhen.BR t_rcvv ()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 serviceprovider 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 [ 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 the asynchronous mode..TP 12.RB [ TNOTSUPPORT ]The call requires the use of a TLI primitive not supported by the underlying transport provider.The can happen when the transport service provider is for service type.BR T_CLTS ..TP 12.RB [ TOUTSTATE ]The call was issued with the interface in a state other than.BR T_DATAXFER " or " T_OUTREL ..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.BR errno (3)..\".\".SH "SEE ALSO".PP.BR readv (2),.BR t_errno (3),.BR t_getinfo (3),.BR t_look (3),.BR t_open (3)..\".\".SH "BUGS".PP.BR t_rcvv ()has no known bugs..BR t_rcvv ()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