libxnet.texi

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

* t_rcv::                       Receive data on a connection-oriented transport endpoint.
* t_rcvconnect::                Receive connection confirmation.
* t_rcvdis::                    Receive disconnect indication.
* t_rcvleafchange::             Receive a leaf change on a point-multipoint connection.
* t_rcvrel::                    Receive an orderly release indication.
* t_rcvreldata::                Receive an orderly release indication with user data.
* t_rcvudata::                  Receive a unit data indication.
* t_rcvuderr::                  Receive a unit data error indication.
* t_rcvv::                      Receive data a place in gather buffers.
* t_rcvvudata::                 Receive a unit data indication an place in gather buffers.
* t_removeleaf::                Remove a leaf from a point-to-multipoint connection.
* t_snd::                       Send data.
* t_snddis::                    Send disconnect request.
* t_sndrel::                    Send an orderly release request.
* t_sndreldata::                Send an orderly release request with data.
* t_sndudata::                  Send a unit data.
* t_sndv::                      Send data from non-contiguous buffers.
* t_sndvudata::                 Send a unit data from non-contiguous buffers.
* t_strerror::                  Provide a descriptive string for an XTI error.
* t_sync::                      Synchronize the XTI library to a new file descriptor.
* t_sysconf::                   Examine XTI library system configuration parameters.
* t_unbind::                    Unbind a transport endpoint from a transport adddress.

XTI Header File Reference

* xti::                         XTI Library header file.
* xti_ip::                      Internet Protocol header file.
* xti_mtp::                     SS7 Message Transfer Part header file.
* xti_sccp::                    SS7 Signalling Connection Control Part header file.
* xti_sctp::                    Stream Control Transmission Protocol header file.
* xti_ss7::                     SS7 header file.
* xti_sscop::                   Service Specific Connection Oriented Protocol header file.
* xti_tcap::                    SS7 Transaction Capabilities Application Part header file.
* xti_tcp::                     Transmission Control Protocol header file.
* xti_udp::                     User Datagram Protocol header file.
@end menu

@c --------------------------------------------------------------------------

@ifnottex
@node Acknowledgements, Introduction, Top, Top
@end ifnottex
@unnumbered Acknowledgements
@cindex credits

@menu
* Sponsors::                    Sponsors of the XTI Library
* Contributors::                People who contributed to development of the XTI Library
@end menu

@node Sponsors,  ,  , Acknowledgements
@unnumberedsec Sponsors of the OpenSS7 XTI Library
@cindex sponsors

Funding for completion of the OpenSS7 XTI Library was provided by:

HOB International.

Additional funding for The OpenSS7 Project was provided by:

@node Contributors,  ,  , Acknowledgements
@unnumberedsec Contributors to the OpenSS7 XTI Library
@cindex contributors

The primary contributor to the OpenSS7 XTI Library is Brian F. G. Bidulock.


@node Introduction, Reference, Acknowledgements, Top
@chapter Introduction to the XTI Library
@cindex introduction

This manual documents how to run, install and port the OpenSS7 XTI Library,
and how to report bugs.


@node Reference, Conformance, Introduction, Top
@chapter Reference
@cpindex reference

@menu
* Overview::                    An overview of XTI Functions and Header Files
* XTI Function Reference::      Reference manual of XTI Functions
* XTI Header File Reference::   Reference manual of XTI Header Files

XTI Function Reference

* t_accept::                    Accept a connection request.
* t_addleaf::                   Add a leaf to a point-multipoint connection.
* t_alloc::                     Allocate an XTI library structure.
* t_bind::                      Bind a transport endpoint to a transport address.
* t_close::                     Close a transport endpoint.
* t_connect::                   Connect a transport endpoint to a transport address.
* t_errno::                     Report XTI library errors.
* t_error::                     Generate an XTI error message.
* t_free::                      Free an XTI library structure.
* t_getinfo::                   Get protocol-specific transport endpoint information.
* t_getprotaddr::               Get local and remote transport addresses.
* t_getstate::                  Get the state of the transport endpoint.
* t_listen::                    Listen for connection requests.
* t_look::                      Retrieve an asynchronous event.
* t_open::                      Open a transport endpoint.
* t_optmgmt::                   Perform options management for a transport endpoint.
* t_rcv::                       Receive data on a connection-oriented transport endpoint.
* t_rcvconnect::                Receive connection confirmation.
* t_rcvdis::                    Receive disconnect indication.
* t_rcvleafchange::             Receive a leaf change on a point-multipoint connection.
* t_rcvrel::                    Receive an orderly release indication.
* t_rcvreldata::                Receive an orderly release indication with user data.
* t_rcvudata::                  Receive a unit data indication.
* t_rcvuderr::                  Receive a unit data error indication.
* t_rcvv::                      Receive data a place in gather buffers.
* t_rcvvudata::                 Receive a unit data indication an place in gather buffers.
* t_removeleaf::                Remove a leaf from a point-to-multipoint connection.
* t_snd::                       Send data.
* t_snddis::                    Send disconnect request.
* t_sndrel::                    Send an orderly release request.
* t_sndreldata::                Send an orderly release request with data.
* t_sndudata::                  Send a unit data.
* t_sndv::                      Send data from non-contiguous buffers.
* t_sndvudata::                 Send a unit data from non-contiguous buffers.
* t_strerror::                  Provide a descriptive string for an XTI error.
* t_sync::                      Synchronize the XTI library to a new file descriptor.
* t_sysconf::                   Examine XTI library system configuration parameters.
* t_unbind::                    Unbind a transport endpoint from a transport adddress.

XTI Header File Reference

* xti::                         XTI Library header file.
* xti_ip::                      Internet Protocol header file.
* xti_mtp::                     SS7 Message Transfer Part header file.
* xti_sccp::                    SS7 Signalling Connection Control Part header file.
* xti_sctp::                    Stream Control Transmission Protocol header file.
* xti_ss7::                     SS7 header file.
* xti_sscop::                   Service Specific Connection Oriented Protocol header file.
* xti_tcap::                    SS7 Transaction Capabilities Application Part header file.
* xti_tcp::                     Transmission Control Protocol header file.
* xti_udp::                     User Datagram Protocol header file.

@end menu

@node Overview,  ,  , Reference
@section Overview
@cpindex overview

@node XTI Function Reference,  ,  , Reference
@section XTI Function Reference
@cpindex functions

@page
@node t_accept,  ,  , Reference
@unnumberedsubsec t_accept
@fnindex t_accept

@subsubheading NAME

@strong{t_accept} - accept a connection request

@subsubheading SYNOPSIS
@example
#include <xti.h>

int t_accept(int @var{fd}, int @var{resfd}, struct t_call *@var{call});
@end example

@subsubheading ARGUMENTS
@table @var
@item fd
the transport endpoint upon which a connection indication was received.

@item resfd
the transport endpoint upon which to accept the connection.

@item call
a pointer to a t_call structure containing information about the responding
endpoint and any data to be transferred in response.
@end table

@subsubheading DESCRIPTION
The @var{fd} argument is an integer file descriptor specifying the stream upon
which a previous connection indication was received with t_listen(3), and for
which the connection indication is to now be accepted.

The @var{resfd} argument is an integer file descriptor specifying the stream
upon which to accept the transport connection. @var{resfd} can be the same as
@var{fd} or different. When @var{resfd} is different from @var{fd}, the caller
specifies that the connection is to be accepted on the stream associated with
@var{resfd}. When @var{resfd} is different from @var{fd}, the stream
associated with @var{resfd} must be an XTI/TLI[1..3] stream on the same
transport provider that is either in the @code{T_UNBND} state, or is in the
@code{T_IDLE} state and bound to the same address as the responding address.

@vindex T_IDLE
@vindex T_UNBND

The @var{call} argument is a pointer to a t_call structure, specifying the
responding address, @var{addr}, the response options, @var{opt}, and any response user
data, @var{udata}. format