Manpage of N_OPTMGMT_REQ

N_OPTMGMT_REQ

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

NAME

N_OPTMGMT_REQ, N_optmgmt_req_t - network options management request

DESCRIPTION

This primitive allows the NS user to manage the QOS parameter values associated with the stream.

SYNOPSIS

The format of the message is one M_PROTO(9) message block, and its structure is as follows:

typedef struct {
    ulong PRIM_type;      /* always N_OPTMGMT_REQ */
    ulong QOS_length;     /* length of QOS values */
    ulong QOS_offset;     /* offset of QOS values */
    ulong OPTMGMT_flags;  /* default receipt conf selection */
} N_optmgmt_req_t;

PARAMETERS

PRIM_type

Indicates the primitive type.

QOS_length

Indicates the length of the default values of the QOS parameters as selected by the NS user. In the connection-mode environment these values will be used in subsequent N_CONN_REQ(7) primitives on the stream that do not specify values for these QOS parameters. In the connection-less environment, these values represent the selected QOS values that would apply to each unit data transmission. If the NS user cannot determine the value of a QOS parameter, its value should be set to QOS_UNKNOWN. If the NS user does not specify any QOS parameter values, the length of this field should be set to zero.

QOS_offset

Indicates the offset of the QOS parameters from the beginning of the M_PROTO(9) message block.

OPTMGMT_flags

DEFAULT_RC_SEL: When set, it indicates to the NS provider that the NS user's default selection is for the use of receipt confirmation with every N_DATA_REQ(7) message (applicable only when its use is successfully negotiated via the N_CONN primitives). This default indication is used only when the M_PROTO(9) message block is not present in the N_DATA_REQ(7) primitive. This flag should be ignored in the connection-less environment.

STATE

This primitive is valid in the NS_IDLE state.

NEW STATE

The new state is NS_WACK_OPTREQ.

RESPONSE

The N_OPTMGMT_REQ(7) primitive requires the NS provider to generate one of the following acknowledgeents upon receipt of the primitive:

-: Successful: Acknowledgment is via the N_OK_ACK(7) primitive. At successful completion, the resulting state is NS_IDLE
-: Non-fatal errors: These errors are indicated in the N_ERROR_ACK(7) primitive.The resulting state remains unchanged.

ERRORS

The applicable non-fatal errors are defined as follows:

[NOUTSTATE]: The primitive was issued from an invalid state.
[NBADQOSPARAM]: The QOS parameter values specified are outside the range supported by the NS provider.
[NBADQOSTYPE]: he QOS structure type is not supported by the NS provider.
[NSYSERR]: A system error has occurred and the Linux system error is indicated in the primitive.

HISTORY

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

CONFORMANCE

This interface conforms to NPI Revision 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]: NPI, Open Group CAE Specification: Network Provider Interface (NPI) Specification, Revision 2.0.0, Draft 2, August 17, 1992, (Parsippany, New Jersey), UNIXInternational,Inc., UNIX International Press. <http://www.openss7.org/docs/npi.pdf>
[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]

TRADEMARKS

OpenSS7tm: is a trademark of OpenSS7 Corporation.
Linux®: is a registered trademark of Linus Torvalds.
UNIX®: is a registered trademark of The Open Group.
Solaris®: is a registered trademark of Sun Microsystems.

Other trademarks are the property of their respective owners.

IDENTIFICATION

OpenSS7 XNS Networking: Package strxns version 0.9.2.7 released 2008-10-31.

This document was created by man2html, using the manual pages.
Time: 16:28:18 GMT, May 18, 2013