Important: The information in this document is obsolete and should not be used for new development.
OTRcvOrderlyDisconnect
Clears an incoming orderly disconnect event.C INTERFACE
OSStatus OTRcvOrderlyDisconnect(EndpointREf ref);C++ INTERFACE
OSStatus TEndpoint::RcvOrderlyDisconnect();PARAMETERS
ref
- The endpoint reference of the endpoint acknowledging receipt of the disconnect request.
- function result
- An error code. See Appendix B.
DISCUSSION
You call theOTRcvOrderlyDisconnect
function to acknowledge the receipt of an orderly disconnect event. After using theOTRcvOrderlyDisconnect
function, there will not be any more data to receive. Attempts to receive data will fail with thekOTOutStateErr
result. If the endpoint supports a remote orderly disconnect, you can still send data over the connection if you have not yet called theOTSndOrderlyDisconnect
function.The
OTRcvOrderlyDisconnect
function behaves in the same way in all modes of operation. If there is no disconnection request pending, the function returns with thekOTNoReleaseErr
result. If there is a disconnection request pending, the function returns thekOTNoError
result.The
OTRcvOrderlyDisconnect
function is only supported by those protocols that have aservtype
field of theTEndpointInfo
structure with a valueT_COTS_ORD
orT_TRANS_ORD
.SEE ALSO
"Terminating a Connection".