nn::rdt::CTR::Sender::Close Member Function

Syntax

nn::Result Close(
     void
);

Arguments

None.

Return Values

Returns success if the request was accepted. The function will return failure if it is called when the state of the instance is anything other than SENDER_STATE_OPENED. Specifically, the following values may be returned: ResultSuccess, ResultNotInitialized, ResultUntimelyFunctionCall .

Description

Issues a request to close a connection.

This function is intended to be called to notify the recipient that there is no more data to send. If the call to this function succeeds, the state will transition to SENDER_STATE_CLOSE_REQUESTED. The actual closing of the connection is done within the Process function.

Revision History

2010/06/14
Initial version.

CONFIDENTIAL