xti_sctp.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_sctp.3.man,v 1.1.2.1 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 XTI-SCTP 3 "2004/05/16 02:35:38" "strxnet-0_9_2-4" "X/Open Transport Interface"
.\"
.\"
.SH NAME
.B xti_sctp
\- X/Open Transport Interface \- Corrigendum for Stream Control Transmission Protocol (SCTP) Conformance
.\"
.\"
.SH SYNOPSIS
.PP
.B #include <xti.h>
.br
.B #include <xti_ip.h>
.br
.B #include <xti_sctp.h>
.HP
.BI "int " sctp_xtistr " = t_open(" \fR\*(lq/dev/sctp_t\*(rq\fI ", " flags );
.\"
.\"
.SH DESCRIPTION
.PP
This manual section describes the protocol-specific information that is
relevant for SCTP transport providers.  This section also describes the
protocol-specific information that is relevant when SCTP services are provided
over an IP network using SCTP.
.PP
This section also defines the data structures and constants required for SCTP
transport providers that are exposed through the
.B <xti_sctp.h>
header file.
.\"
.\"
.SH "ADDRESS FORMAT"
.PP
The SCTP address format is structured as follows:
.PP
.nf
\fC\s-1\
struct sockaddr_in {
    sa_family_t         sin_family;  /* Address family */
    unsigned short int  sin_port;    /* Port number */
    struct in_addr      sin_addr;    /* Interned address */
    /* padding */
};
\s+1\fP
.fi
.PP
The
.B sockaddr_in
structure contains the following members:
.TP \w'sin_family\(em'u
.I sin_family
The address family.  Always set to
.BR AF_INET " or " AF_UNSPEC .
.PD 0
.TP
.I sin_port
The port number of the transport endpoint.
.TP
.I sin_addr
The IP address of the transport endpoint.
.TP
.I (padding)
Padding to pad the size of the
.B sockaddr_in
structure to the size of a
.B sockaddr
structure.
.PD
.PP
The structure is padded to the size of a
.BR sockaddr
structure.
.\"
.\"
.SH OPTIONS
.PP
Options are formatted according to the
.B t_opthdr
structure as described in
.BR xti (3).
An SCTP transport provider compliant to this specification supports none, all
or any subset of the options defined here.  An implementation may restrict the
use of any of these options by offering them only in a privileged read-only
mode.
.PP
An SCTP transport provider supports three levels of options.  These three levels
are described below.
.\"
.\"
.SS "XTI_GENERIC"
.PP
Options with this level are specific to the X/Open Transport Interface (XTI/TLI)
and are common to all transport providers.  For more information see
.BR xti (3).
.PP
The options defined with the option level
.B XTI_GENERIC
are as follows:
.TP
.B XTI_DEBUG
Sets debugging flags for the stream.
This option is formatted as an array of
.BR t_uscalar_t .
Legal values are implementation defined.
For more information, see
.BR xti (3).
.TP
.B XTI_LINGER
Sets whether, and the amount of time if, the stream will linger waiting for
unsent data to be delivered.
This option is formatted as a
.B t_linger
structure as follows:
.RS
.PP
.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
.TP \w'l_linger\(em'u
.I l_onoff
Specifies whether to linger
.RB ( T_YES )
or not
.RB ( T_NO ).
Legal values are
.BR T_YES " and " T_NO .
.TP
.I l_linger
Specifies the amount of time (in seconds) to linger.
Legal values are
.BR T_INFINITE ", " T_UNSPEC
and all positive numbers including zero.
.PP
For more information, see
.BR xti (3).
.RE
.TP
.B XTI_RCVBUF
Specifies the size, in bytes, of the receive buffer.
This option is formatted as a
.BR t_uscalar_t .
Legal values are all positive, non-zero numbers.
For more information, see
.BR xti (3).
.TP
.B XTI_RCVLOWAT
Specifies the low water mark above which received data will be indicated and
delivered to the user.
This option is formatted as a
.BR t_uscalar_t .
Legal values are all positive, non-zero numbers.
For more information, see
.BR xti (3).
.TP
.B XTI_SNDBUF
Specifies the size, in bytes, of the transmit buffer.
This option is formatted as a
.BR t_uscalar_t .
Legal values are all positive, non-zero numbers.
For more information, see
.BR xti (3).
.TP
.B XTI_SNDLOWAT
Specifies the low water mark above which queued data will be transmitted to
the peer.
This option is formatted as a
.BR t_uscalar_t .
Legal values are all positive, non-zero numbers.
For more information, see
.BR xti (3).
.\"
.\"
.SS "T_INET_IP"
.PP
Options within this level are specific to the Internet Protocol (IP) and are
common to all the protocol levels in IP.  For more information, see
.BR xti_ip (3).
.PP
The options defined with the option level
.B T_INET_IP
are as follows:
.\"
.\"
.TP
.B T_IP_OPTIONS
This option determines the IP options to be sent with every packet from this
transport endpoint.  See
.BR xti_ip (3)
for additional information.
.\"
.\"
.TP
.B T_IP_PKTINFO
Determines whether a
.I T_IP_PKTINFO
option indicating additional packet information associated with the received
packet will be included in a
.BR T_OPTDATA_IND (7)
messge as well as reflected in the response to the current value
.B T_GET
operation to
.BR t_optmgmt (3).
The option value is a
.B t_scalar_t
with valid values
.BR T_YES " or " T_NO .
This option is for use with
.BR t_optmgmt (3).
.sp
This option is for use with the
.BR sockets (3)
library.
For
.BR xti (3)
it changes the semantics of the value returned to a
.B T_GET
operation to
.BR t_optmgmt (3).
When set to
.BR T_YES ,
the current value obtained with a
.B T_GET
operation to
.BR t_optmgmt (3)
will be the value of the last received message.
When set to
.BR T_NO ,
the current value obtains with a
.B T_GET
operation to
.BR t_optmgmt (3)
will be the default value or the value last set with a
.B T_NEGOTIATE
operation to
.BR t_optmgmt (3)
.\"
.\"
.TP
.B T_IP_RECVTOS
Determine whether a
.I T_IP_TOS
option indicating the type of service field for the received packet will be
included in a
.BR T_OPTDATA_IND (7)
messge as well as reflected in the response to the current value
.B T_GET
operation to
.BR t_optmgmt (3).
The option value is a
.B t_scalar_t
with valid values
.BR T_YES " or " T_NO .
This option is for use with
.BR t_optmgmt (3).
.sp
This option is for use with the
.BR sockets (3)
library.
For
.BR xti (3)
it changes the semantics of the value returned to a
.B T_GET
operation to
.BR t_optmgmt (3).
When set to
.BR T_YES ,
the current value obtained with a
.B T_GET
operation to
.BR t_optmgmt (3)
will be the value of the last received message.
When set to
.BR T_NO ,
the current value obtains with a
.B T_GET
operation to
.BR t_optmgmt (3)
will be the default value or the value last set with a
.B T_NEGOTIATE
operation to
.BR t_optmgmt (3)
See
.IR T_IP_TOS .
.\"
.\"
.TP
.B T_IP_RECVTTL
Determine whether a
.I T_IP_TTL
option indicating the time to live for the received packet will be
included in a
.BR T_OPTDATA_IND (7)
messge as well as reflected in the response to the current value
.B T_GET
operation to
.BR t_optmgmt (3).
The option value is a
.B t_scalar_t
with valid values
.BR T_YES " or " T_NO .
This option is for use with
.BR t_optmgmt (3).
.sp
This option is for use with the
.BR sockets (3)
library.
For
.BR xti (3)
it changes the semantics of the value returned to a
.B T_GET
operation to
.BR t_optmgmt (3).
When set to
.BR T_YES ,
the current value obtained with a
.B T_GET
operation to
.BR t_optmgmt (3)
will be the value of the last received message.
When set to
.BR T_NO ,
the current value obtains with a
.B T_GET
operation to
.BR t_optmgmt (3)
will be the default value or the value last set with a
.B T_NEGOTIATE
operation to
.BR t_optmgmt (3)
See
.IR T_IP_TTL .
.\"
.\"
.TP
.B T_IP_RECVOPTS
Determine whether a
.I T_IP_OPTIONS
option indicating the IP options for the received packet will be
included in a
.BR T_OPTDATA_IND (7)
messge as well as reflected in the response to the current value
.B T_GET
operation to
.BR t_optmgmt (3).
The option value is a
.B t_scalar_t
with valid values
.BR T_YES " or " T_NO .
This option is for use with
.BR t_optmgmt (3).
.sp
This option is for use with the
.BR sockets (3)
library.
For
.BR xti (3)
it changes the semantics of the value returned to a
.B T_GET
operation to
.BR t_optmgmt (3).
When set to
.BR T_YES ,
the current value obtained with a
.B T_GET
operation to
.BR t_optmgmt (3)
will be the value of the last received message.
When set to
.BR T_NO ,
the current value obtains with a
.B T_GET
operation to
.BR t_optmgmt (3)
will be the default value or the value last set with a
.B T_NEGOTIATE
operation to