nn::nex::Station Class

Syntax

class Station : private nn::nex::DuplicatedObject

Description

Expresses information about the stations (the machines participating in a session).

Each machine participating in a session through this class can be managed. The Station class itself is managed as a duplicated object.

Enumerated Types

State Enumerated type that indicates the current state of the station.
ProcessType Enumerated type that indicates this station's process type.

typedef Definitions

SelectionIterator This iterator is for enumerating Station objects.

Member Constants

S STATION_UNKNOWN_RTT Indicates an invalid RTT.

Member Functions

S GetLocalStation Gets the duplicated object handle for the station representing the machine currently running.
S GetLocalInstance Gets a pointer to the duplicated object for the station that represents the machine currently running.
S ConvertStationIDToDOHandle Converts from the StationID to the DOHandle of the Station.
S ConvertConnectionIDToDOHandle Converts from the StationID to the DOHandle of the Station. Using this function is not recommended. Use the ConvertStationIDToDOHandle function.
S ConvertDOHandleToID Specifies the DOHandle for any particular Station and converts it to a unique ID (StationID) for the P2P session. Using this function is not recommended. Use the ConvertDOHandleToStationID function.
S ConvertDOHandleToStationID Specifies the DOHandle for any particular Station and converts it to a unique ID (StationID) for the P2P session.
S ConvertDOHandleToDOID Specify any Station DOHandle to convert to the DOID.
S SetLocalIdentificationToken Sets the identification token for the local station. The value set by this function can be accessed by other stations using GetIdentificationToken. Do not call this function until after you have created the Net-Z instance.
S SetLocalPlayerName Sets the player name and language code for the local station.
S SetLocalApplicationVersion Sets the application version for the local station. Any application-defined numerical value can be specified. The value set by this function can be accessed by other stations with the GetApplicationVersion function. Do not call this function until after you have created the Net-Z instance.
S GetLocalObserver Gets the observer for the local station. Used during dead reckoning.
S RegisterObserver Registers a duplicated object as the observer for the station. Used during dead reckoning.
S UnregisterObserver Unregisters the observer for a station. Used during dead reckoning.
S FlushAllBundles Sends all messages registered in message bundles.
S KickMe Makes the local station leave the session. The local station is disconnected by being handled as a fault from the surrounding stations, and the Session::CheckGameIsOver function becomes true. When in thread-safe mode, it is thread-safe.
S RegisterOperationBeginCallback Registers the callback to call each time StationOperation is run.
S RegisterOperationEndCallback Registers the callback to call each time StationOperation is run.
S GetApprovedStationNum Returns the number of stations approved to join a session. To approve or reject joining a session, use a callback registered with the Session::RegisterJoinApprovalCallback function. The station acting as the session master is always counted as approved.
Station Do not call this constructor directly from applications. Created automatically by Net-Z when joining a session.
V ~Station Do not call this destructor directly from applications. Destroyed automatically by Net-Z when leaving a session.
GetState Gets the current status of a station.
IsAPeer Gets whether this station is a remotely connected partner participating in the session.
IsLocal Gets whether the station instance represents the local machine itself.
GetProcessType Gets the process type of this station.
GetIdentificationToken Gets the identification token for this station.
GetPlayerName Gets the player name for this station.
GetLanguageCode Gets the language code for the player name for this station.
GetPrincipalID Gets the principal ID for this station.
GetApplicationVersion Gets the application version of this station.
V ApproveEmigration Returns whether the duplicated object migrates.
V ApproveFaultRecovery Returns whether to use fault recovery for duplicated objects.
V OperationBegin Called every time a duplicated object system operation is started.
V OperationEnd Called every time a duplicated object system operation ends.
IsConnected Gets whether the machine currently running has a connection to this station.
GetObserver Gets the observer for a station. Used during dead reckoning.
GetRTT Gets the current RTT value between the local station and partner station.
GetRTTAverage Gets the average RTT value between the local station and partner station.
V Trace Traces the state of this duplicated object. (Used in debugging.)
GetEndPointInfoInterface Gets the EndPointInfoInterface for the station.
GetStationURLs Gets the valid StationURL list for this station.
GetStationURL Gets the URL as a string for this station.
FlushBundle Sends all messages currently stored in this station as a message bundle.
SignalFault Forcibly disconnects the specified station. Feature for debugging.
GetStationID Gets the ID to specify stations (machines) currently in a session. There is no guarantee that the StationID will be sequential values, and it is possible that the values assigned to a new station after replacing the master may be out of sequence. In a station participating with P2P, it is guaranteed to be unique.
GetConnectionID Gets the ID to specify a station (machine) during communication. Using this function is not recommended. Use the GetStationID function.
GetNumOfRoutingConnections Gets the number of connections through the master for this station.
KickStation Makes the specified station leave the session. The specified station is disconnected by being handled as a fault from the surrounding stations, and the Session::CheckGameIsOver function becomes true.

Class Hierarchy

nn::nex::DuplicatedObject
  nn::nex::Station

Revision History

2011/01/27
Initial version.

CONFIDENTIAL