t_optdata_req.7

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

'\" rt
.\" -*- nroff -*-
.\"
.\" @(#) T_OPTDATA_REQ.7,v 1.1.4.1 2004/01/12 23:45:24 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.
.\"
.\" =========================================================================
.\"
.\" Modified 2004/01/12 23:45:24 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_OPTDATA_REQ 7 "2004/01/12 23:45:24" "LiS-2_16_18-8" "Transport Provider Interface (TPI)"
.SH NAME
.B T_OPTDATA_REQ
\- Data request with options
.SH SYNOPSIS
The message consists of one
.B M_PROTO
message block followed by zero or more message blocks, where each
.B M_DATA
message block contains zero or more bytes of data.  The format of the
.B M_PROTO
message block is as follows:
.sp
.nf
\fC\s-1\
struct T_optdata_req {
   t_scalar_t PRIM_type;       /* always T_OPTDATA_REQ           */
   t_scalar_t DATA_flag;       /* flag bits associated with data */
   t_scalar_t OPT_length;      /* options length                 */
   t_scalar_t OPT_offset;      /* options offset                 */
};
\fR\s+1
.fi
.SH DESCRIPTION:
The primitive indicates to the transport provider that the message contains
a transport interface data unit.  One or more transport interface data units
form a transport service data units (TSDU).
.PP
Note that the maximum transport service and data unit sizes allowed by
transport provider is indicated to the user by the
.BR T_INFO_ACK (7)
primitive.
.PP
This primitive has a mechanism that indicates the beginning and end of a
transport service data unit.  However not all transport providers support
the concept of a transport service data unit.
.PP
This primitive also provides mechanisms to have options associated with the
data being transferred.
.SH PARAMETERS
The fields of this message have the following semantics:
.TP 16
.I PRIM_type
identifies the primitive type
.TP
.I DATA_flag
This field specifies bit fields specific general properties associated
with the data being transferred.  The following settings are currently
defined:
.RS
.TP
.B T_ODF_MORE
When set, this bit indicates that the next
.BR T_OPTDATA_REQ (7)
primitive is also part of this transport service data unit.
.RE
.TP
.I OPT_length
the length of the requested options asociated with the primitive
.TP
.I OPT_offset
the offset (from the beginning of the
.B M_PROTO
message block) where the options asociated with this primitive begin.
.SH RULES
It is possible to use this primitive with no associated options, in which case
the
.I OPT_length
field is zero.
.PP
The primitive does not require any acknowledgements, although it may
generate a fatal error.  This is indicated via a
.B M_ERROR
message type, which results in the failure of all operating system service
routines on the stream.
.SH ERRORS
The allowable errors are as follows:
.TP 16
.RB [ EPROTO ]
This indicates of the following unrecoverable protocol conditions:
.RS
.IP - 3
Thetransport service interface was found to be in an incorrect
state.  If the interface is in TS_IDLE state when the provider receives the
.BR T_OPTDATA_REQ (7)
primitive, then the transport provider should just drop the message without
generating a fatal error.
.IP -
The amount of transport user data associated with the primitive
defines a transport service data unit larger than that allowed by the
transport provider.
.RE
.SH MODES
Only connection mode
.SH ORIGINATOR
Transport user
.SH "SEE ALSO"
.BR T_OPTDATA_IND (7),
.BR T_DATA_REQ (7),
.BR T_DATA_IND (7),
.BR T_EXDATA_REQ (7),
.BR T_EXDATA_IND (7).
.SH VERSIONS
.PP
This manpage was written for
.B LiS\c
.
.[
LiS
.]
.br
The Transport Provider Interface first appeared in SVR 4.
.[
svr4
.]
.br
This interface conforms to TPI Version 2, Draft 2.
.XX
.[
TPI Revision 2.0.0
.]
.[
magic
.]
.[
advprog
.]
.[
$LIST$
.]
.T2