tpi_sctp.7.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
.\"
.\" @(#) tpi_sctp.7.man,v 1.1.2.1 2004/05/16 02:35:50 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:50 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 TPI-SCTP 7 "2004/05/16 02:35:50" "strxnet-0_9_2-4" "Transport Provider Interface"
.SH NAME
.B tpi_sctp
\- Transport Provider Interface (TPI) \- Stream Control Transmission Protocol (SCTP) Corrigendum
.SH SYNOPSIS
.PP
.B #include <sys/tihdr.h>
.br
.B #include <sys/tpi_ip.h>
.br
.B #include <sys/tpi_sctp.h>
.HP
.BI "int " sctp_stream " = open(" \fR\*(lq/dev/sctp_t\*(rq\fI ", " flags );
.SH DESCRIPTION
.PP
.PP
.B TPI-SCTP
provides a stream supporting the Transport Provider Interface,
.BR tpi (7),
to the Stream Control Transmission Protocol,
.[
rfc2960
.]
.[
rfc3309
.]
.[
sctpig
.]
.BR sctp (7).
This
.IR STREAMS (4)
interface provides the
.BR sctp (7)
protocol service interface using the T-primitives of the
.BR tpi (7).
This interface is intended solely for use by user programs or protocol modules
requiring the common
.BR tpi (7)
interfae, such as the
.BR xti (3)
and
.BR sockets (3)
library.
.SS "ADDRESS FORMATS"
.PP
.SH "OPTIONS"
.PP
.PP
.B TPI-SCTP
provides options at the
.B T_INET_SCTP
option level as described in the section that follow.  Of the
.B T_INET_SCTP
level protocol options, none of the options are of end-to-end significance.
.SS T_SCTP_NODELAY
.PP
.PP
.SS T_SCTP_CORK
.PP
.PP
.SS T_SCTP_PPI
.PP
.PP
.SS T_SCTP_SID
.PP
.PP
.SS T_SCTP_SSN
.PP
.PP
.SS T_SCTP_TSN
.PP
.PP
.SS T_SCTP_RECVOPT
.PP
.PP
.SS T_SCTP_COOKIE_LIFE
.PP
.PP
.SS T_SCTP_SACK_DELAY
.PP
.PP
.SS T_SCTP_PATH_MAX_RETRANS
.PP
.PP
.SS T_SCTP_ASSOC_MAX_RESTRANS
.PP
.PP
.SS T_SCTP_MAX_INIT_RETRIES
.PP
.PP
.SS T_SCTP_HEARTBEAT_ITVL
.PP
.PP
.SS T_SCTP_RTO_INITIAL
.PP
.PP
.SS T_SCTP_RTO_MIN
.PP
.PP
.SS T_SCTP_RTO_MAX
.PP
.PP
.SS T_SCTP_OSTREAMS
.PP
.PP
.SS T_SCTP_ISTREAMS
.PP
.PP
.SS T_SCTP_COOKIE_INC
.PP
.PP
.SS T_SCTP_THROTTLE_ITVL
.PP
.PP
.SS T_SCTP_MAC_TYPE
.PP
.PP
.SS T_SCTP_HB
.PP
.PP
.sp
.nf
\fC\s-1\
typedef struct t_sctp_hb {
    uint32_t hb_dest;           /* destination address */
    t_uscalar_t hb_onoff;       /* activation flag */
    t_uscalar_t hb_itvl;        /* interval in milliseconds */
} t_sctp_hb_t;
\s+1\fR
.fi
.SS T_SCTP_RTO
.PP
.PP
.sp
.nf
\fC\s-1\
typedef struct t_sctp_rto {
    uint32_t rto_dest;          /* destination address */
    t_uscalar_t rto_initial;    /* RTO.Initial (milliseconds) */
    t_uscalar_t rto_min;        /* RTO.Min (milliseconds) */
    t_uscalar_t rto_max;        /* RTO.Max (milliseconds) */
    t_uscalar_t max_retrans;    /* Path.Max.Retrans (retries) */
} t_sctp_rto_t;
\s+1\fR
.fi
.SS T_SCTP_MAXSEG
.PP
.PP
.SS T_SCTP_STATUS
.PP
.PP
.sp
.nf
\fC\s-1\
typedef struct t_sctp_dest_status {
    t_uscalar_t dest_addr;      /* dest address */
    t_uscalar_t dest_cwnd;      /* dest congestion window */
    t_uscalar_t dest_unack;     /* dest unacknowledged chunks */
    t_uscalar_t dest_srtt;      /* dest smooth round trip time */
    t_uscalar_t dest_rvar;      /* dest rtt variance */
    t_uscalar_t dest_rto;       /* dest current rto */
    t_uscalar_t dest_sst;       /* dest slow start threshold */
} t_sctp_dest_status_t;
\s+1\fR
.fi
.sp
.nf
\fC\s-1\
typedef struct t_sctp_status {
    t_uscalar_t curr_rwnd;      /* current receive window */
    t_uscalar_t curr_rbuf;      /* current receive buffer */
    t_uscalar_t curr_nrep;      /* current dests reported */
    t_sctp_dest_status_t curr_dest[0];  /* current primary dest */
} t_sctp_status_t;
\s+1\fR
.fi
.SS T_SCTP_DEBUG
.PP
.PP
.TP
.B SCTP_OPTION_DROPPING
causes the stream to drop packets.
.TP
.B SCTP_OPTION_BREAK
causes the stream to break the first destination.
.TP
.B SCTP_OPTION_DBREAK
causes the stream to break destinations in both directions.
.TP
.B SCTP_OPTION_RANDOM
causes the stream to drop packets at random.
.SH "LOCAL MANAGEMENT INTERFACE"
.PP
.PP
.SS T_INFO_REQ
.PP
.PP
This primitive is interpreted as in
.BR tpi (7).
.SS T_INFO_ACK
.PP
.TP
.I TSDU_size
.TP
.I ETSDU_size
.B SCTP
supports the concept of expedited data.  Expedited data is data that is sent
unordered.  This field should always return the same value as the
.I TSDU_size
above.
.TP
.I CDATA_size
.B SCTP
supports the concept of connection data.  This field will be the maximum
amount of data that will fit in a COOKIE-ECHO or COOKIE-ACK message.
.TP
.I DDATA_size
.B SCTP
does not support the concept of disconnection data and this field will always
return
.BR T_INVALID .
.TP
.I ADDR_size
The maximum size of the
.B SCTP
address.  This field will always return an integer multiple of the
.B sockaddr_in
structure size as described under
.IR \*(lqADDRESS FORMAT\*(rq ,
above.
.TP
.I OPT_size
This is the maximum size of the
.I OPT_length
field in T-primitives which support options.
.TP
.I TIDU_size
This is the maximum size of the interface data unit, which is the maximum size
of data that can be transferred across the interface in a single
.BR getmsg "(2) or " putmsg (2)
system call.  This size is always less than or equal to the
.I TSDU_size
above.
.TP
.I SERV_type
The service type is one of the following:
.RS
.TP
.B T_CLTS
Connectionless service.
.B SCTP
does not support connectionless service.
This value will never be returned by
.BR SCTP .
.TP
.B T_COTS
Connection-oriented service.
.B SCTP
does not support connection-oriented service without orderly release.
This value will never be returned by
.BR SCTP .
.TP
.B T_COTS_ORD
Connection-oriented service with orderly release.
.B SCTP
supports connection-oriented service with orderly release.
.RE
.TP
.I CURRENT_state
The current state of the service interface as described in
.BR tpi (7).
.TP
.I PROVIDER_flag
Provider flags are a bitwise OR of the following:
.RS
.TP
.B T_SNDZERO
Indicates that the transport user is permitted to send data with a message
length of zero.
.B SCTP
does not support the transmission of zero-length TSDUs.  This flag must be
clear.
.TP
.B XPG4_1
Indicates that the transport provider conforms to XTI in XTP4 and supports the
new primitives
.BR T_ADDR_REQ "(7) and " T_ADDR_ACK (7).
This flag is normally set.
.RE
.SS T_ADDR_REQ
.PP
This primitive is interpreted as in
.BR tpi (7).
.PP
.SS T_ADDR_ACK
.PP
.PP
.TP
.IR LOCADDR_length ", " LOCADDR_offset
Indicates the length and offset from the beginning of the message block of the
.B sockaddr_in
structures that describes the
.B SCTP
addresses to which the stream is bound.
If the stream is not in a bound state, then
.IR LOCADDR_length " and " LOCADDR_offset
return zero (0).
.TP
.IR REMADDR_length ", " REMADDR_offset
Indicates the length and offset from the beginning of the message block of the
.B sockaddr_in
structures that describes the
.B SCTP
addresses to which the stream is connected.
If the stream is not in a connected or connecting state, then