ipcshutdown(2)

Requires Optional LAN/X.25 Software

NAME

ipcshutdown − release a NetIPC descriptor

SYNOPSIS

#include <sys/ns_ipc.h>

void ipcshutdown(

ns_int_t descriptor,
ns_int_t ∗flags,
short opt[],
ns_int_t ∗result);

DESCRIPTION

ipcshutdown is used to release a descriptor. The referenced descriptor can be a call socket descriptor, virtual circuit (VC) socket descriptor, or destination descriptor. Once a descriptor has been realeased, the descriptor can no longer be used by the calling process. Since the descriptor may be shared between processes, it is destroyed only if the calling process is the last process referencing it.

When a call socket, VC socket, or destination descriptor is destroyed, all resources are released and the descriptor name(s) in the local socket registry are removed. Shutting down a VC socket does not affect any call sockets, and shutting down a call socket does not affect any VC sockets created using the call socket.

All of the data in transit on a VC socket, including any data that has already been queued on the destination VC socket, may be destroyed when the connection is shut down unless the NSF_GRACEFUL_RELEASE flag is set. If a process sends important data to its peer process just prior to shutting that process down, it is recommended that the calling process receive a confirmation from the peer process before calling ipcshutdown or exiting, or use the NSF_GRACEFUL_RELEASE flag to ensure that the data was received.

PARAMETERS

descriptor (input parameter) The descriptor to be released. Can be a call socket descriptor, VC socket descriptor, or destination descriptor.

flags (input parameter) Must be 0 or NSF_GRACEFUL_RELEASE. See below.

opt (input parameter) No options are defined for this call. Can be 0 or a pointer to an empty NetIPC option buffer.

result (output parameter) The error code returned. Refer to "Diagnostics" below for more information.

Flags Parameter

NSF_GRACEFUL_RELEASE
If this flag is set, the underlying network protocol can continue to transmit data after the calling process exits.

RETURN VALUE

None. Errors are returned to the result parameter.

DIAGNOSTICS

[NSR_DESC] The descriptor parameter is not a valid VC socket descriptor, call socket descriptor, or destination descriptor.

[NSR_FLAGS] The flags parameter is illegal or unsupported.

[NSR_NO_ERROR] The call was successful.

[NSR_OPT_OPTION] An unsupported option was specified.

[NSR_OPT_SYNTAX] A length or offset within the opt parameter is invalid or unsupported.

AUTHOR

ipcshutdown was developed by HP.

Museum

Related Articles