nn::nex::RMCContext Class

Syntax

class RMCContext : public nn::nex::DOCallContext

Description

Defines the context for RMCs.

Before making a Remote Method Call (RMC), you must define the context of that call using the RMCContext class. Use this class to set the flags and the remote station on which to make the call. You can also include the call's CallContext::State and DOCallContextOutcome information in this class.

For details on implementing RMCs, see the NEX Programming Manual.

Enumerated Types

Type Enumerated type that represents the call type. (Inherits DOCallContext.)
Flags Enumerated type that defines flags that can be used in the CallContext. (Inherits DOCallContext.)
Outcome Enumerated type that represents the result of a call. (Inherits DOCallContext.)
State Enumerated type that represents the CallContext state. (Inherits CallContext.)

typedef Definitions

CompletionCallback Defines CompletionCallback. (Inherits CallContext.)

Member Functions

RMCContext Initializes a context.
SetOutcome Sets the outcome (result) for this RMCContext.
V Trace Traces the content of this CallContext object. Automatically disabled when executed in release mode.
SetTargetStation Sets the target station of the call. (Inherits DOCallContext.)
GetTargetStation Gets the target station of the call. (Inherits DOCallContext.)
V FlagsAreValid Gets whether the combination of flags (Flags) is valid.
ClearTargets Clears the target station(s) that have previously been set for this DOCallContext. (Inherits DOCallContext.)
Wait Forces the system to wait until asynchronous processes complete or the timeout is exceeded. (Inherits DOCallContext.)
Cancel The call is automatically canceled if DOCallContext is deleted. (Inherits DOCallContext.)
SetSubStreamID For reliable communication, specifies the SubStreamID to use during sending. (Inherits DOCallContext.)
GetSubStreamID For reliable communication, gets the SubStreamID to use during sending. (Inherits DOCallContext.)
GetOutcome Gets the result of the asynchronous process as DOCallContext::Outcome. (Inherits DOCallContext.)
SetTimeout Sets a timeout for asynchronous processes. (Inherits CallContext.)
GetState Returns the current CallContext state. (Inherits CallContext.)
SetUserContext Sets the UserContext associated with this CallContext. (Inherits CallContext.)
GetUserContext Returns the UserContext associated with this CallContext. (Inherits CallContext.)
SetFlag Sets the flags used for asynchronous processes. (Inherits CallContext.)
ClearFlag Clears the flags that were set using SetFlag. (Inherits CallContext.)
FlagIsSet Returns whether a particular flag has been set. (Inherits CallContext.)
RegisterCompletionCallback Sets the operation to execute when this CallContext completes. (Inherits CallContext.)
Reset Resets the CallContext state to Available. (Inherits CallContext.)
AcquireRef Increments the reference count by 1. (Inherits RefCountedObject.)
ReleaseRef Decrements the reference count by 1. Deletes itself when the count reaches 0. (Inherits RefCountedObject.)
S GetOutcomeString Converts to a name corresponding to the DOCallContext::Outcome value. (Inherits DOCallContext.)

Class Hierarchy

nn::nex::RootObject
  nn::nex::RefCountedObject
    nn::nex::CallContext
      nn::nex::DOCallContext
        nn::nex::RMCContext

Revision History

2011/01/28
Initial version.

CONFIDENTIAL