nn::nex::ProtocolCallContext Class

Syntax

class ProtocolCallContext : public nn::nex::CallContext

Description

The CallContext class for communicating with the game server.

The CallContext class for communicating with the game server. NEX requires the passing of a valid ProtocolCallContext class object for asynchronous functions involved in communications processes with the game server.

If you are setting a timeout period, specify a time longer than 30 seconds.

Enumerated Types

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

typedef Definitions

CompletionCallback Defines CompletionCallback. (Inherits CallContext.)

Member Functions

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.)
V FlagsAreValid Determines whether the combination of flags currently being used is valid.
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.)
Wait Forces the system to wait until asynchronous processes complete or the timeout is exceeded. (Inherits CallContext.)
Cancel Cancels the asynchronous process associated with this CallContext. (Inherits CallContext.)
GetOutcome Gets the result of the asynchronous process as a qResult value. (Inherits CallContext.)
Trace Traces the content of this CallContext object. Automatically disabled when executed in release mode. (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.)

Class Hierarchy

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

Revision History

2011/01/27
Initial version.

CONFIDENTIAL