nn::nex::MigrationContext Class

Syntax

class MigrationContext : public nn::nex::DOCallContext

Description

Provides asynchronous management features needed for calling migration-related functions.

Migration is the act of transferring control of a duplicated object to a different station.

Before you migrate a duplicated object, you must first use this class to define the call. This class can set flags within the limits of this class, and can get information by calling the CallContext::State or DOCallContext::Outcome functions. Migrate objects by calling the DuplicatedObject::Emigrate or DuplicatedObject::AttemptEmigration function.

There are two main processes in migration. The first process to execute is emigration and refers to transferring control of a duplicated object. The next process to execute is immigration and refers to receiving a duplicated object.

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

MigrationContext Initializes an object.
GetMigratingObject Gets a handle to a migrating duplicated object.
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::MigrationContext

Revision History

2011/01/27
Initial version.

CONFIDENTIAL