T_OPTMGMT_REQ(D7tpi)
T_OPTMGMT_REQ --
Options Management
Synopsis
This message consists of a M_PROTO message block
formatted as follows:
struct T_optmgmt_req {
long PRIM_type; /* always T_OPTMGMT_REQ */
long OPT_length; /* options length */
long OPT_offset; /* options offset */
long MGMT_flags; /* 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.
The proper alignment of the options is not guaranteed.
The options are however, aligned the same as it was received from the
transport user.
Rules
For the rules governing the requests made by this primitive see the
T_OPTMGMT_ACK
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.
Non-fatal errors-
These errors will be indicated via the
T_ERROR_ACK
primitive
described in
Errors
The allowable errors are as follows:
TACCES-
This indicates that the user did not have proper permissions for the
use of the requested options.
TOUTSTATE-
The primitive would place the transport interface out of state.
TBADOPT-
This indicates that the options as specified were in an incorrect format, or
they contained invalid information.
TBADFLAG-
This indicates that the flags as specified were incorrect or invalid.
TSYSERR-
A system error has occurred and the UNIX system error is indicated in the
primitive.
TNOTSUPPORT-
This primitive is not supported by the transport provider.
Modes
Both connection-mode and connectionless-mode.
Originator
Transport user.
Notices
Hardware constraints
None
Applicability
N/A
Backward compatibility
UnixWare-specific TPI Message Formats
Forward compatibility
N/A
19 June 2005
© 2005 The SCO Group, Inc. All rights reserved.
OpenServer 6 and UnixWare (SVR5) HDK - June 2005