t_optmgmt.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
.\"
.\" @(#) t_optmgmt.3.man,v 0.9.2.2 2004/05/16 02:35:36 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:36 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 T_OPTMGMT 3 "2004/05/16 02:35:36" "strxnet-0_9_2-4" "OpenSS7 XTI/TLI Library"
.\"
.\"
.SH NAME
.B t_optmgmt
\- manage transport options
.\"
.\"
.SH SYNOPSIS
.PP
.B #include <xti.h>
.HP 8
.BI "int t_optmgmt(int " fd ", const struct t_optmgmt *" req ", struct t_optmgmt *" ret );
.\"
.\"
.SH ARGUMENTS
.PP
.TP
.I fd
the transport endpoint for which to manage options.
.TP
.I req
a pointer to a
.B t_optmgmt
structure containing the requested options.
.TP
.I ret
a pointer to a
.BR t_optmgmt
structure to contain the returned options.
.\"
.\"
.SH DESCRIPTION
.PP
.BR t_optmgmt ()
manages options associated with the underlying transport provider for the
endpoint
.IR fd .
.PP
.I fd
specifies the local transport endpoint upon which to manage options.
.PP
.I req
is a pointer to a
.B t_optmgmt
structure that provides the passed in option names and values.
.PP
.I ret
is a pointer to a
.B t_optmgmt
structure that provides the returned option names and values.
.PP
The
.B t_optmgmt
structure is formatted as follows:
.sp
.nf
\fC\s-1\
struct t_optmgmt {
        struct netbuf opt;
        t_scalar_t flags;
};
\fR\s+1
.fi
.PP
The
.B t_optmgmt
structure passes and returns the following members and information.
.TP
.I opt
is a
.BR netbuf (3)
structure that contains passed in
.IR "" ( req )
or returned
.IR "" ( ret )
options names and values.  Options are structured as described below under
.IR "\(lqOPTIONS\(rq" .
The
.IR req->opt.len and ret->opt.maxlen
is significant on call and the
.I ret->opt.len
is significant on return.
If
.I req->opt.len
is zero on call, no option names and values are passed.
If
.I ret->opt.maxlen
is zero on call or
.I ret->opt.len
is zero on return, no option names and values are returned.
.TP
.I flags
specifies and returns management flags.
.RS
.PP
The flags specified in 
.I req->flags
request one of four possible actions to be performed on the option contained
in the request,
.IR req->opt .
The flags specified
can be one of the following values:
.TP \w'T_PARTSUCCESS\(em'u
.B T_DEFAULT
requests that the default options for the specified option names, or if
.I req->opt.len
is zero, all default options, be returned.
.TP
.B T_CURRENT
requests that the current options for the specified option names, or if
.I req->opt.len
is zero, all current options, be returned.
.TP
.B T_CHECK
requests that the options specified in
.I req
be checked for validity and validity reported in
.IR ret .
.TP
.B T_NEGOTIATE
requests that the options specified in
.I req
be negoitated and the negotiated values returned in
.IR ret .
.PP
The flags returned in
.I ret->flags
represents the single most severe result of the operation.  The flags returned
will be one of the following values (in order of decreasing severity):
.TP \w'T_PARTSUCCESS\(em'u
.B T_NOTSUPPORT
indicates that at least one of the options specified in
.I req->opt
was not supported by the transport provider at the current privilege level of
the requesting user.
.TP
.B T_READONLY
indicates that at least one of the options specified in
.I req->opt
is read-only (for the current XTI/TLI state).
This return flag does not apply when the request flag was
.BR T_DEFAULT .
.TP
.B T_FAILURE
indicates that negotiation of at least one of the options specified in
.I req->opt
failed.  This is not used for illegal format or values.
This return flag does not apply when the request flag was
.BR T_DEFAULT " or " T_CURRENT .
.TP
.B T_PARTSUCCESS
indicates that the negotiation of at least one of the options specified in
.I req->opt
was negotiated to a value of lesser quality than the value requested.
This return flag only applies when the request flag was
.BR T_NEGOTIATE .
.TP
.B T_SUCCESS
indicates that all of the specified options were negotiated or returned
successfully.
.RE
.\"
.\"
.SH OPTIONS
.PP
Options within the
.I opt
buffer of the
.B t_optmgmt
structure (and other structures including XTI/TLI options) are formatted as a
contiguous list of options.  Each option in the list begins with a
.B t_opthdr
structure formatted as follows:
.sp
.nf
\fC\s-1\
struct t_opthdr {
    t_uscalar_t len;    /* Option length, incl. header */
    t_uscalar_t level;  /* Option level */
    t_uscalar_t name;   /* Option name */
    t_uscalar_t status; /* Negotiation result */
    char value[0];      /* and onwards...  */
};
\fR\s+1
.fi
.PP
The
.B t_opthdr
strucuture contains the following members:
.TP
.I len
the length of the option including the length of this header and the length of
the option value that follows.
.TP
.I level
the level of the option.
.I level
values are transport service provider specific with the exception of the
.B XTI_GENERIC
option level.
(See
.BR xti (3)).
.TP
.I name
the name of the option within the
.IR level .
.I name
values are transport service provider specific, with the exception of the
.B XTI_GENERIC
option names.
(See
.BR xti (3)).
.TP
.I status
the negotiation status of the option on return, ignored on input.
.TP
.I value
the value of the option.  This is a variable lenght field, the length of which
is specific to the option specified by
.IR level " and " name .
The format of option values is transport service provider specific.
.PP
Option headers in the options list are always aligned in memory to permit
direct access to the header.  This means that the next option in the list will
begin on the next alignment boundary for a
.B t_opthdr
structure.  A macro is provided to assist the XTI/TLI application writer in
locating the next option in the option list.
.PP
A number of macros are provided to assist with handling options in option
lists.  These macros are decribed as follows:
.TP
.BI T_OPT_FIRSTHDR( b )
takes a an argument
.I b
a pointer to the
.BR netbuf (3)
structure describing the options list and returns a pointer to the first
.B t_opthdr
structure in the list.
.TP
.BI T_OPT_NEXTHDR( b ", " p )
takes as arguments
.I b
a pointer to the
.BR netbuf (3)
structure describing the options list and
.I p
a pointer to the
.B t_opthdr
for the current option, and returns a pointer to the
.B t_opthdr
of the next option in the list, or
.B NULL
if there is no next option in the list.
.TP
.BI T_OPT_DATA( p )
takes as an argument
.I p
a pointer to the
.B t_opthdr
for the options and returns a unsigned character pointer to the
.I value
for the option.
.\"
.\"
.SH FLAGS
.PP
.BR t_optmgmt ()
provides four flags to specify what management actions are to be performed on
the specified options:
.BR T_DEFAULT ", " T_CURRENT ", " T_CHECK " and " T_NEGOTIATE .
.PP
For all actions, the transport user specifies the options that are of interest
and values (if required by the manamgement action) in
.IR req->opt.buf .
For each option level, the option
.B T_ALLOPT
can be requested on input.  All supported options of this level will then be
selected for the management action.
If