INDConnector::Disconnect Method

2010-07-02

Disconnects the endpoint from the peer.

Syntax

HRESULT Disconnect(
  [in, out]  OVERLAPPED *pOverlapped
);

Parameters

pOverlapped [in, out]
A pointer to an OVERLAPPED structure that is used to indicate completion of the operation.

Return Value

When you implement this method, you should return the following return values. If you return others, try to use well-known values to aid in debugging issues.

Return code	Description
ND_SUCCESS	The operation succeeded.
ND_PENDING	The request is pending and will be completed when the listening peer is disconnected.
ND_CANCELED	The endpoint was removed.
ND_DEVICE_REMOVED	The underlying Network Direct adapter was removed from the system.
ND_CONNECTION_INVALID	The endpoint is not connected.

Remarks

This method implicitly flushes all outstanding requests.

You can reuse the endpoint after the request completes.

Either side of the connection can terminate the connection; the disconnect handshake is protocol dependent.

Implementation Notes

Calling the INDEndpoint::Release method on the endpoint without first disconnecting is valid. If the last reference does not disconnect before releasing, the object should implicitly disconnect. Disconnecting should implicitly flush pending requests (the pending requests will show up in the completion queue with an ND_CANCELED status).

Requirements

Product	Microsoft Message Passing Interface (MS-MPI)
Header	Ndspi.h

Share via