T_OPTMGMT_REQ

Section: Transport Provider Interface (TPI) (7)
Updated: 2008-10-31
Index Return to Main Contents

NAME

T_OPTMGMT_REQ - Options Management

SYNOPSIS

This message consists of a M_PROTO message block formatted as follows:

struct T_optmgmt_req {
    t_scalar_t   PRIM_type;      /* Always T_OPTMGMT_REQ */
    t_scalar_t   OPT_length;
    t_scalar_t   OPT_offset;
    t_scalar_t   MGMT_flags;
};

DESCRIPTION

This primitive allows the transport user to manage the options associated with the stream. The format of the message is one M_PROTO message block.

PARAMETERS

PRIM_type

indicates the primitive type

OPT_length

is the length of the protocol options associated with the primitive

OPT_offset

is the offset from the beginning of the M_PROTO block where the options begin.

MGMT_flags

are the flags which define the request made by the transport user. The allowable flags are:

T_NEGOTIATE: Negotiate and set the options with the transport provider
T_CHECK: Check the validity of the specified options
T_DEFAULT: Return the default options
T_CURRENT: Return the currently effective option values.

The proper alignment of the options is not guaranteed. The options are, however, aligned the same as received from the transport user.

RULES

For the rules governing the requests made by this primitive see the T_OPTMGMT_ACK(7) primitive.

This primitive requires the transport provider to generate one of the following acknowledgments on receipt of the primitive, and that the transport user wait for the acknowledgment before issuing any other primitives:

Successful

Acknowledgment of the primitive via the T_OPTMGMT_ACK(7).

Non-fatal errors

These errors will be indicated via the T_ERROR_ACK(7) primitive described in Overview of Error Handling Capabilities.

ERRORS

The allowable errors are as follows:

[TACCES]: The user did not have proper permissions for the use of the requested options.
[TBADFLAG]: The flags as specified were incorrect or invalid.
[TBADOPT]: The options as specified were in an incorrect format, or they contained invalid information.
[TOUTSTATE]: The primitive would place the transport interface out of state.
[TNOTSUPPORT]: This primitive is not supported by the transport provider.
[TSYSERR]: A system error has occurred and the Linux system error is indicated in the primitive.

MODES

Both connection-mode and connectionless-mode.

ORIGINATOR

Transport user.

HISTORY

The Transport Provider Interface first appeared in SVR 4[1].

CONFORMANCE

This interface conforms to TPI Version 2, Draft 2[2].

REFERENCES

[1]: SVR 4, UNIX® System V Release 4 Programmer's Manual, 1990, (Englewood Cliffs, New Jersey), AT&T UNIX System Laboratories, Inc., Prentice Hall.
[2]: TPI Revision 2.0.0, Open Group CAE Specification: Transport Provider Interface (TPI) Specification, Revision 2.0.0, Draft 2, 1999, (Berkshire, UK), OpenGroup, Open Group Publication. <http://www.opengroup.org/onlinepubs/>
[3]: Magic Garden, The Magic Garden Explained: The Internals of UNIX® System V Release 4 / An Open Systems Design, 1994, (Australia), B. Goodheart, J. Cox, Prentice Hall. [ISBN 0-13-098138-9]
[4]: Advanced Programming in the UNIX®Environment, 15th edition, December 1997, (Reading, Massachusetts), W. R. Stevens, Addison Wesley. [ISBN 0-201-56317-7]