t_rcvconnect.3

7号信令功能代码,为开源代码

'\" rtp
.\" -*- nroff -*- vim: ft=nroff
.\"
.\" @(#) t_rcvconnect.3,v 1.1.4.1 2004/01/12 23:32:51 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:51 by brian
.\"
.\" =========================================================================
.so lis.macros
.R1
bracket-label "\fR[\fB" "\fR]" "\fR, \fB"
no-default-database
database lis.refs
accumulate
move-punctuation
abbreviate A
join-authors ", " ", " " and "
et-al " et al" 2 3
abbreviate-label-ranges ".."
sort-adjacent-labels
.R2
.\"
.\"
.\"
.\"
.TH T_RCVCONNECT 3 "2004/01/12 23:32:51" "LiS-2_16_18-8" "Linux Fast-STREAMS XTI Library"
.\"
.\"
.SH NAME
.B t_rcvconnect
\- receive connection request confirmation
.\"
.\"
.SH SYNOPSIS
.PP
.B #include <xti.h>
.HP 8
.BI "int t_rcvconnect(int " fd ", struct t_call *" call );
.\"
.\"
.SH ARGUMENTS
.PP
.TP 12
.I fd
the transport endpoint upon which to receive the connection confirmation.
.TP
.I call
a pointer to a
.B t_call
structure to contain returned information about the connected peer.
.\"
.\"
.SH DESCRIPTION
.PP
.I fd
specifies the local transport endpoint upon which to receive the connection
confirmation.
.PP
.I call
is a pointer to a
.B t_call
structure that returns information about the responding transport endpoint
including the remote address, options and connection data.
The
.B t_call
structure is formatted as follows:
.sp
.nf
\fC\s-1\
struct t_call {
        struct netbuf addr;             /* address */
        struct netbuf opt;              /* options */
        struct netbuf udata;            /* user data */
        int sequence;                   /* sequence number */
};
\fR\s+1
.fi
.PP
The
.B t_call
structure returns the following members and information:
.TP 12
.I addr
is a
.BR netbuf (3)
structure that returns the responding transport address.
The
.I call->addr.maxlen
field is significant on call and the
.I call->addr.len
field is significant on return.
When
.I call->addr.maxlen
is zero, no responding address will be returned.
When
.I call->addr.len
returns zero, not responding address was available.
.TP 12
.I opt
is a
.BR netbuf (3)
structure that returns the responding transport options.
The
.I call->opt.maxlen
field is significant on call and the
.I call->opt.len
field is significant on return.
When
.I call->opt.maxlen
is zero, no responding options will be returned.
When
.I call->opt.len
returns zero, not responding options were available.
.TP 12
.I udata
is a
.BR netbuf (3)
structure that returns the responding connection data.
The
.I call->udata.maxlen
field is significant on call and the
.I call->udata.len
field is significant on return.
When
.I call->udata.maxlen
is zero, no responding connection data will be returned.
When
.I call->udata.len
returns zero, not responding connection data was available.
.TP 12
.I sequence
is not used by
.BR t_rcvconnect ()
and is left unchanged.
.\"
.\"
.SH CAVEATS
.PP
.BR t_rcvconnect ()
is only valid in state
.BR T_OUTCON .
.PP
In synchronous mode,
.BR t_rcvconnect ()
will block until a connection confirmation or asynchronous event occurs on
.IR fd .
In asynchronous mode,
if a connection confirmation is not immediately available,
.BR t_rcvconnect ()
will fail, return -1 and set
.IR t_errno (3)
to
.BR TNODATA .
.PP
A call to
.BR t_rcvconnect ()
is not normally necessary in synchronous mode.
In synchronous mode,
.BR t_connect (3)
normally blocks until a connection confirmation is received.
.BR t_rcvconnect ()
is typically used in asynchronous mode, where
.BR t_connect (3)
returns immediately after call and
.BR t_rcvconnect ()
is needed to receive the connection confirmation.
.\"
.\"
.SH "RETURN VALUE"
.PP
Upon success,
.BR t_rcvconnect ()
returns zero (0).
Upon failure,
.BR t_rcvconnect ()
returns -1 and sets
.IR t_errno (3)
to an appropriate error number.
.\"
.\"
.SH ERRORS
.PP
When
.BR t_rcvconnect ()
fails, it returns -1 and sets
.IR t_errno (3)
to an appropriate error number as follows:
.TP 12
.RB [ TBADF ]
.I fd
is invalid.
.TP 12
.RB [ TBUFOVFLW ]
The \fImaxlen\fR field of a \fBnetbuf\fR(3) structure,
.IR "" ( addr ", " opt ", " udata ),
passed to the call was
non-zero, but insufficient to hold the available information.  See,
\fBnetbuf\fR(3) for more information.
.TP 12
.RB [ TLOOK ]
An asynchronous event occured before the call could complete.  See \fBt_look\fR(3) for more information.
.TP 12
.RB [ TNODATA ]
An attempt was made to read data but no data indication was available and
.I fd
was set for asynchronous mode operation with
.BR O_NONBLOCK " or " O_NDELAY
in a call to
.BR 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 underlying transport provider is of the connectionless service type
.RB [R T_CLTS . ]
.TP 12
.RB [ TOUTSTATE ]
The call was issued with the interface in a state other than
.RB [R T_OUTCON . ]
.TP 12
.RB [ TPROTO ]
A protocol error occured between the XTI library and the underlying transport provider.
.TP 12
.RB [ TSYSERR ]
A \fBLinux\fR system error occured and the \fBLinux\fR error number is set in \fIerrno\fR(3).
.\"
.\"
.SH "SEE ALSO"
.PP
.BR errno (3),
.BR fcntl (2),
.BR netbuf (3),
.BR t_connect (3),
.BR t_errno (3),
.BR t_look (3),
.BR t_open (3).
.\"
.\"
.SH "BUGS"
.PP
.BR t_rcvconnect ()
has no known bugs.
.BR t_rcvconnect ()
has been tested for the described behavior using the
.I /usr/bin/test-xnet
conformance test program.
.\"
.\"
.SH "CONFORMING TO"
.PP
XTI/TLI,
.[
XTI
.]
TPI,
.[
TPI Revision 2.0.0
.]
XPG5,
XNS 5.2,
.[
xns
.]
SUSv2.
.[
susv2
.]
.\"
.\"
.[
$LIST$
.]
.TI