xti.3.man

This a separate release of the OpenSS7 X/Open XTI/TLI library, TLI modules (timod, tirdwr) and the I

'\" rtp
.\" -*- nroff -*- vim: ft=nroff noautoindent nocindent nosmartindent
.\"
.\" @(#) xti.3.man,v 0.9.2.3 2004/05/16 02:35:38 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/05/16 02:35:38 by brian
.\"
.\" =========================================================================
.so strxnet.macros
.R1
bracket-label "\fR[\fB" "\fR]" "\fR, \fB"
no-default-database
database strxnet.refs
accumulate
move-punctuation
abbreviate A
join-authors ", " ", " " and "
et-al " et al" 2 3
abbreviate-label-ranges ".."
sort-adjacent-labels
.R2
.\"
.\"
.\"
.\"
.TH XNET 3 "2004/05/16 02:35:38" "strxnet-0_9_2-4" "OpenSS7 XTI/TLI Library"
.\"
.\"
.SH NAME
.BR xti ", " xnet
\- XNS 5.2 XTI/TLI Library
.BR "" ( libxnet )
.\"
.\"
.SH SYNOPSIS
.PP
.B #include <sys/xti.h>
.HP 8
.BI "int t_accept(int " fd ", int " connfd ", struct t_call *" call );
.HP 8
.BI "void *t_alloc(int " fd ", int " type ", int " fields );
.HP 8
.BI "int t_bind(int " fd ", struct t_bind *" req ", struct t_bind *" ret );
.HP 8
.BI "int t_close(int " fd );
.HP 8
.BI "int t_connect(int " fd ", struct t_call *" sndcall ", struct t_call *" rcvcall );
.HP 8
.BI "extern int t_errno;"
.HP 8
.BI "void t_error(char *" errmsg ) ;
.HP 8
.BI "int t_free(void *" ptr ", int " type );
.HP 8
.BI "int t_getinfo(int " fd ", struct t_info *" info );
.HP 8
.BI "int t_getstate(int " fd );
.HP 8
.BI "int t_listen(int " fd ", struct t_call *" call );
.HP 8
.BI "int t_look(int " fd );
.HP 8
.BI "int t_open(char *" path ", int " oflag ", struct t_info *" info );
.HP 8
.BI "int t_optmgmt(int " fd ", const struct t_optmgmt *" req ", struct t_optmgmt *" ret );
.HP 8
.BI "int t_rcvconnect(int " fd ", struct t_call *" call );
.HP 8
.BI "int t_rcvdis(int " fd ", struct t_discon *" dis );
.HP 8
.BI "int t_rcv(int " fd ", char *" buf ", unsigned int " nbytes ", int *" flags );
.HP 8
.BI "int t_rcvreldata(int " fd ", struct t_discon *" discon );
.HP 8
.BI "int t_rcvrel(int " fd );
.HP 8
.BI "int t_rcvudata(int " fd ", struct t_unitdata *" data ", int *" flags );
.HP 8
.BI "int t_rcvuderr(int " fd ", struct t_uderr *" err );
.HP 8
.BI "int t_rcvv(int " fd ", struct t_iovec *" iov ", unsigned int " iovcnt ", int *" flags );
.HP 8
.BI "int t_rcvvudata(int " fd ", struct t_unitdata *" data ", struct t_iovec *" iov ", unsigned int " iovcnt ", int *" flags );
.HP 8
.BI "int t_snddis(int " fd ", const struct t_call *" call );
.HP 8
.BI "int t_snd(int " fd ", char *" buf ", unsigned int " nbytes ", int " flags );
.HP 8
.BI "int t_sndreldata(int " fd ", struct t_discon *" discon );
.HP 8
.BI "int t_sndrel(int " fd );
.HP 8
.BI "int t_sndudata(int " fd ", struct t_unitdata *" data );
.HP 8
.BI "int t_sndv(int " fd ", struct t_iovec *" iov ", unsigned int " iovcnt ", int " flags );
.HP 8
.BI "int t_sndvudata(int " fd ", struct t_unitdata *" data ", struct t_iovec *" iov ", unsigned int " iovcnt ", int " flags );
.HP 8
.BI "int t_sync(int " fd );
.HP 8
.BI "int t_unbind(int " fd );
.\"
.\"
.SH DESCRIPTION
.PP
.B libxnet
is an
.B OpenSS7
implementation of the XNS 5.2 XTI/TLI Library for
.B LiS
(Linux STREAMS).
.\"
.\"
.SH OPTIONS
.PP
.\"
.\"
.SS "XTI/TLI Generic Options"
.PP
Several options are independent of transport service provider.  These options
are specified at the option level
.BR XTI_GENERIC ,
and are defined as follows:
.\"
.TP
.B XTI_DEBUG
This option enables debugging.  The values of this option are implementation
defined.  Debugging is disabled if the option is specified with \*(lqno
value\*(rq; that is, with an option header only.  The system supplies
utilities to process the traces.  Note that an implementation may also provide
other means for debugging.
.RS
.PP
This option is formatted as an array of
.BR t_uscalar_t .
This option is an
.IR "absolute requirement" .
Legal values are implementation defined.
.PP
This option can be negotiated in any XTI/TLI transport endpoint state.
This option can be negotiated using the
.BR t_optmgmt "(3), " t_connect "(3) or " t_accept (3)
XTI/TLI library calls.
.RE
.\"
.TP
.B XTI_LINGER
This option is used to linger the execution of a
.BR t_close "(3) or " close (2)
if send data is still queue in the send buffer.  The option value specifies
the linger period.  If a
.BR close "(2) or " t_close (3)
is issued and the send buffer is not empty, the system attempts to send the
pending data within the linger period before closing the endpoint.  Data still
pending after the linger period has elapsed is discarded.
.RS
.PP
Depending on the implementation,
.BR t_close "(3) or " close (2)
either blocks for, at maximum, the linger period, or immediately returns,
whereupon the system holds the connection in existence for at most the linger
period.
.PP
This option is formatted as a
.B t_linger
structure, with the following members:
.sp
.nf
\fC\s-1\
struct t_linger {
    t_scalar_t l_onoff;    /* option on/off */
    t_scalar_t l_linger;   /* linger time */
};
\s+1\fP
.fi
.PP
The value of
.I l_onoff
is
.B T_YES
(on) or
.B T_NO
(off).
.I l_onoff
is an
.IR "absolute requirement" .
.PP
The value of
.I l_linger
determines the linger period in seconds.  The transport user can request the
default value by setting the to
.BR T_UNSPEC .
The default timeout value depends on the underlying transport provider (it is
often
.BR T_INFINITE ).
Legal values for this field are
.BR T_UNSPEC ", " T_INFINITE
and all non-negative numbers.
.I  l_linger
is not an
.IR "absolute requirement" .
The implementation may place upper and lower limits on the
.I l_linger
option value.  Requests that fall short of the lower limit are negotiated to
the lower limit.  Legal values are all positive numbers.
.PP
This option can be negotiated in any XTI/TLI transport endpoint state; however, the
negotiated value is not effective until
.BR t_close (3)
or
.BR close (2)
is called.
This option can be negotiated using the
.BR t_optmgmt "(3), " t_connect "(3) or " t_accept (3)
XTI/TLI library calls.
.PP
There are notes in
.B Linux 2.4
TCP code that say that if
.I l_onoff
is set to
.B T_YES
and
.I l_linger
is set to zero (0), that, per
.IR "RFC 793" ,
.[
rfc 793
.]
an abort will be sent.  This might be a way to resolve the problem sending
aborts.
.RE
.\"
.TP
.B XTI_RCVBUF
This option is used to adjust the internal buffer size allocated for the
receive buffer.  The buffer size may be increased for high-volume
connections, or decreased to limit the possible backlog of incoming data.
.RS
.PP
This option is formatted as a
.BR t_uscalar_t .
This request is not an
.IR "absolute requirement" .
The implementation may place upper and lower limits on the option value.
Requests that fall short of the lower limit are negotiated to the lower limit.
Legal values are all positive numbers.
.PP
This option can be negotiated in any XTI/TLI state; however, the negotiated value
will not be effective until the
.B T_DATAXFER
state is acheived.  This option can be negotiated using the
.BR t_optmgmt "(3), " t_connect "(3) or " t_accept (3)
XTI/TLI library calls.
.RE
.\"
.TP
.B XTI_RCVLOWAT
This option is used to set a low-water mark in the receive buffer.  The
option value gives the minimal number of bytes that must have accumulated
in the receive buffer before they become visible to the transport user.