CD_ABORT_OUTPUT_REQ

Section: Communications Device Interface (CDI) (7)
Updated: 2008-10-31
Index Return to Main Contents

NAME

CD_ABORT_OUTPUT_REQ - abort output

SYNOPSIS

This primitive consists of one M_PROTO(9) or M_PCPROTO(9) message block structured as follows:

typedef struct {
    cd_ulong cd_primitive;
} cd_abort_output_req_t;

DESCRIPTION

This user originated primitive requests that any transmission operation currently in progress be aborted.

Parameters

This primitive contains the following parameters:

cd_primitive: Specifies the primitives type.

State

This primitive is valid in any state in which the output section is enabled, but no local acknowledgment is pending. The new state remains unchanged unless the current state is CD_OUTPUT_ACTIVE, in which case the new state is CD_ENABLED or CD_INPUT_ALLOWED, depending on the state of the input section.

RESPONSE

This primitive requires the CD provider to acknowledge receipt of the primitive as follows:

Successful: Upon success, the provider acknowledges the receipt of the primitive with the CD_OK_ACK(7) primitive. The new state is unchanged.

Unsuccessful (non-fatal errors): Upon failure, the provider acknowledges the receipt of the primitive with the CD_ERROR_ACK(7) including the reaons for failure. The new state remains unchanged.

Note: if the output section is not active at the time that the CD_ABORT_OUTPUT_REQ is issued, but the communications device is enabled, the provider should discard the CD_ABORT_OUTPUT_REQ primitive and not issue any non-fatal error.

ERRORS

Non-Fatal Errors:

[CD_BADPRIM]: Unrecognized primitive.
[CD_DISC]: Disconnected.
[CD_EVENT]: Protocol-specific event occurred.
[CD_FATALERR]: Device has become unusable.
[CD_NOTSUPP]: Primitive not supported by this device.
[CD_OUTSTATE]: Primitive was issued from an invalid state.
[CD_PROTOSHORT]: M_PROTO block too short.
[CD_SYSERR]: UNIX system error.

FILES

HISTORY

The Communications Device Interface first appeared in SVR 4[1].

CONFORMANCE

This interface conforms to CDI with Gcom extensions.

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]: 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]
[3]: Advanced Programming in the UNIX®Environment, 15th edition, December 1997, (Reading, Massachusetts), W. R. Stevens, Addison Wesley. [ISBN 0-201-56317-7]