nn::nex::JoinStationOperation Class

Syntax

class JoinStationOperation : public nn::nex::StationOperation

Description

This operation executes when a station joins a session.

If the StationOperation::GetType of the StationOperation obtained by the callbacks registered by Station::RegisterOperationBeginCallback and Station::RegisterOperationEndCallback is Operation::JoinStation, you can use JoinStationOperation::DynamicCast to get the pointer to this class.

Depending on when communications are disconnected, there may be times when the callback at the beginning of the join-in process gets called, but the callback to end the join-in process does not.


Using JoinStationOperation with a callback registered by Station::RegisterOperationBeginCallback
・This operation starts the station join-in process.
・The station that can be obtained by GetTargetStation has not completed the process yet.
・ After this point, data from DirectStream can be received, and it can be stored in an internal NEX buffer and referenced, but we recommend referencing the received data after the join-in process has completed.




Using JoinStationOperation with a callback registered by Station::RegisterOperationEndCallback
・Indicates the end of the station join-in process.
・The station that can be obtained by GetTargetStation has already completed the join-in process, so if you want to send application-specific data by using DirectStream and RMC, go ahead and do so from this point.
・Depending on the timing, the packets from this station may have arrived before this point.

Enumerated Types

Type Enumerated type that represents the types of operations called by the system. (Inherits Operation.)

Member Functions

GetTargetStation Gets the station that is the target of this operation. (Inherits StationOperation.)
PV GetType Returns the type of this operation object.
GetUserData Gets user-defined values. (Inherits Operation.)
SetUserData Sets user-defined values. (Inherits Operation.)
PV GetClassNameString Gets the class name of this operation object.
S DynamicCast Casts dynamically by using run-time information. (Inherits Operation.)
S SetTraceFilter Sets the callback function that specifies when to run traces on operation objects. (Inherits Operation.)

Class Hierarchy

nn::nex::RootObject
  nn::nex::Operation
    nn::nex::StationOperation
      nn::nex::JoinStationOperation

Revision History

2012/05/25
Initial version.

CONFIDENTIAL