nn::nex::CallContext Class

Syntax

class CallContext : public nn::nex::RefCountedObject

Description

Root class for the asynchronous process management classes.

When NEX runs asynchronous processes for communicating with a server or for other reasons, it passes the CallContext class or one of its subclasses as arguments to the asynchronous functions. (For example, with server communication the subclass is the ProtocolCallContext class.) You can also use the CallContext class to get the states and results of asynchronous processes, cancel or reset the processes, and configure timeouts.

Enumerated Types

State Enumerated type that represents the CallContext state.
Flags Enumerated type that defines flags that can be used in the CallContext.

typedef Definitions

CompletionCallback Defines CompletionCallback.

Member Functions

CallContext Constructor.
V ~CallContext Destructor.
SetTimeout Sets a timeout for asynchronous processes.
GetState Returns the current CallContext state.
SetUserContext Sets the UserContext associated with this CallContext.
GetUserContext Returns the UserContext associated with this CallContext.
SetFlag Sets the flags used for asynchronous processes.
V FlagsAreValid Determines whether the combination of flags currently being used is valid.
ClearFlag Clears the flags that were set using SetFlag.
FlagIsSet Returns whether a particular flag has been set.
RegisterCompletionCallback Sets the operation to execute when this CallContext completes.
Reset Resets the CallContext state to Available.
Wait Forces the system to wait until asynchronous processes complete or the timeout is exceeded.
Cancel Cancels the asynchronous process associated with this CallContext.
GetOutcome Gets the result of the asynchronous process as a qResult value.
Trace Traces the content of this CallContext object. Automatically disabled when executed in release mode.
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.)

Class Hierarchy

nn::nex::RootObject
  nn::nex::RefCountedObject
    nn::nex::CallContext

Revision History

2011/01/27
Initial version.

CONFIDENTIAL