nn::rdt::CTR::Receiver::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 RECEIVER_STATE_FINISHED. Specifically, the following values may be returned: ResultSuccess, ResultNotInitialized, and ResultUntimelyFunctionCall.

Description

Issues a request to revert an instance to the CLOSED state.

This function is intended to be called once you have verified that all data has been received. If the call to this function succeeds, the state will transition to RECEIVER_STATE_CLOSED.

Revision History

2010/06/14
Initial version.

CONFIDENTIAL