tpi.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.7.man,v 0.9.2.4 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 7 "2004/05/16 02:35:50" "strxnet-0_9_2-4" "Linux STREAMS"
.SH NAME
.B tpi
\- Transport Provider Interface
.SH SYNOPSIS
.PP
.B #include <sys/tpi.h>
.HP
.BI "int " tpi_stream " = open(" tpi_device ", " flags );
.HP
.BI "int " tpi_xtistr " = t_open(" tpi_device ", " flags);
.HP
.BI "int " tpi_socket " = socket(" pfamily ", " socktype ", " protocol );
.SH DESCRIPTION
.PP
.\"
.\"
.\"
.\"
.\"
.\"
.PP
To support a framework for providing networking products in the
.BR UNIX \(rg
system, an effort is underway to define service interfaces that map to
strategic levels of the Open Systems Interconnection (OSI) Reference Model.
These service interfaces hide implementation details of a particular service
from the consumer of the service.  This enables system programmers to develop
software independent of the particular protocol that provides a specific
service.  The interfaces being specified for
.BR UNIX \(rg
System V are defined within the
.IR STREAMS (4)
environment.  This document specifies a kernel-level interface that supports
the services of the Transport Layer for connection-mode and connectionless
mode services.  This specification applies to System V Release 4.2 ES/MP.
.SS "Transport Provider Interface"
.PP
.PP
The transport interface defines a message interface to a transport provider
implemented under
.IR STREAMS (4).
(It is assumed that the reader of this document is familiar with the concept
.IR STREAMS (4).)
This version of the transport provider interface supports the XPG4 version of
the X/Open Transport Interface (XTI/TLI).  A user communicates to a transport
provider via a full duplex path known as a stream.  This stream provides a
mechanism in which messages may be passed to the transport provider from the
transport user and vice versa.
.PP
.IR STREAMS (4)
messages that are used to communicate transport service primitives between the
transport user and the transport provider may have one of the following
formats:
.IP 1. 4
A
.B M_PROTO
message block followed by zero or more
.B M_DATA
message blocks.  The
.B M_PROTO
message block contains the type of transport service primitive and all the
relevant arguments associated with the primitive.  The
.B M_DATA
blocks contain transport user data associated with the transport service
primitive.
.IP 2. 4
One
.B M_PCPROTO
message block containing the type of transport service primitive and all the
relevant arguments associated with the primitive.
.IP 3. 4
One or more
.B M_DATA
message blocks containing transport user data.
.PP
The following sections describe the transport primitives which define both a
connection-mode and connectionless-mode transport service.  For both types of
transport service, two types of primitives exist: primitives which originate
from the transport user and primitives which originate from the transport
provider.  The primitives which originate from the transport user make
requests to the transport provider or respond to an event of the transport
provider.  The primitives which originate from the transport provider are
either confirmations of a request or are indications to the transport user
that an event has occurred.  Section 2 lists the primitive types along with
the mapping of those primitives to the
.IR STREAMS (4)
message types and the transport primitives of the ISO IS 8072 and IS 8072/DAD
transport service definitions.  The format of these primitives and the rules
governing the use of them are described in the sections that follow.
.\"
.\"
.\"
.\"
.SS "Local Management"
.PP
The following management primitives are common to all modes of transport
service providers.
The transport service provider provides the following local management
services:
.PP
.B Information Service
The information service provides the transport services user with the ability
to query the transport service provider concerning options and parameters
specific to the transport service provider and associated with the transport
connection.
The information services use the following primitives:
.IP \(em \w'\(em\(em'u
.BR T_INFO_REQ (7):
Requests information concerning the transport service provider, limits, modes
and options.
This primitive requires local acknowledgment with the
.BR T_INFO_ACK "(7) or " T_ERROR_ACK (7)
primitives
.IP \(em \w'\(em\(em'u
.BR T_INFO_ACK (7):
Provides information concerning the transport service provider, limits, modes
and options.
.PP
.B Bind Service
The bind service provides the transport services user with the ability to bind
the requesting stream to a transport endpoint address.  The bind service also
permits the negotiation of the number of outstanding connection indications on
a connection mode transport service provider.
The bind service uses the following primitives:
.IP \(em \w'\(em\(em'u
.BR T_BIND_REQ (7):
Requests the binding of the stream to a transport endpoint address.
This primitive requires local acknowledgment with the
.BR T_BIND_ACK "(7) or " T_ERROR_ACK (7)
primitives.
.IP \(em \w'\(em\(em'u
.BR T_BIND_ACK (7):
Provides acknowledgment of the bound transport endpoint address.
.PP
.B Unbind Service
The unbind service provides the transport services user with the ability to
unbind the requesting stream from the transport endpoint address to which it
is currently bound.
The unbind service uses the following primitives:
.IP \(em \w'\(em\(em'u
.BR T_UNBIND_REQ (7):
Requests the stream be unbound from the bound transport endpoint address.
This primitive requires local acknowledgment with the
.BR T_OK_ACK "(7) or " T_ERROR_ACK (7)
primitives.
.PP
.B Receipt Acknowledgment Service
The receipt acknowledgment service provides an indication to the transport
service user of the positive or negative acknowledgment of the previous
primitive issued by the channel service user.
The receipt acknowledgment service uses the following primitives:
.IP \(em \w'\(em\(em'u
.BR T_OK_ACK (7):
Provides positive acknowledgment of request and response primitives that
require acknowledgment.
.IP \(em \w'\(em\(em'u