class RMCContext : public nn::nex::DOCallContext
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.
Type
|
Enumerated type that represents the call type. (Inherits from DOCallContext .) |
|
---|---|---|
Flags
|
Enumerated type that defines flags that can be used in the CallContext . (Inherits from DOCallContext .) |
|
Outcome
|
Enumerated type that represents the result of a call. (Inherits from DOCallContext .) |
|
State
|
Enumerated type that represents the CallContext state. (Inherits from CallContext .) |
CompletionCallback
|
Defines CompletionCallback . (Inherits from CallContext .) |
---|
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 from DOCallContext .) |
|
GetTargetStation
|
Gets the target station of the call. (Inherits from 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 from DOCallContext .) |
|
Wait
|
Forces the system to wait until asynchronous processes complete or the timeout is exceeded. (Inherits from DOCallContext .) |
|
Cancel
|
The call is automatically canceled if DOCallContext is deleted. (Inherits from DOCallContext .) |
|
SetSubStreamID
|
For reliable communication, specifies the SubStreamID to use during sending. (Inherits from DOCallContext .) |
|
GetSubStreamID
|
For reliable communication, gets the SubStreamID to use during sending. (Inherits from DOCallContext .) |
|
GetOutcome
|
Gets the result of the asynchronous process as DOCallContext::Outcome . (Inherits from DOCallContext .) |
|
SetTimeout
|
Sets a timeout for asynchronous processes. (Inherits from CallContext .) |
|
GetState
|
Returns the current CallContext state. (Inherits from CallContext .) |
|
SetUserContext
|
Sets the UserContext associated with this CallContext . (Inherits from CallContext .) |
|
GetUserContext
|
Returns the UserContext associated with this CallContext . (Inherits from CallContext .) |
|
SetFlag
|
Sets the flags used for asynchronous processes. (Inherits from CallContext .) |
|
ClearFlag
|
Clears the flags that were set using SetFlag . (Inherits from CallContext .) |
|
FlagIsSet
|
Returns whether a particular flag has been set. (Inherits from CallContext .) |
|
RegisterCompletionCallback
|
Sets the operation to execute when this CallContext completes. (Inherits from CallContext .) |
|
Reset
|
Resets the CallContext state to Available . (Inherits from CallContext .) |
|
AcquireRef
|
Increments the reference count by 1. (Inherits from RefCountedObject .) |
|
ReleaseRef
|
Decrements the reference count by 1. Deletes itself when the count reaches 0 . (Inherits from RefCountedObject .) |
|
S |
GetOutcomeString
|
Converts to a name corresponding to the DOCallContext::Outcome value. (Inherits from DOCallContext .) |
nn::nex::RootObject
nn::nex::RefCountedObject
nn::nex::CallContext
nn::nex::DOCallContext
nn::nex::RMCContext
CONFIDENTIAL