class JoinSessionOperation : public nn::nex::SessionOperation
This session operation is executed when a station joins a session.
When a Station attempts to join a Session, the JoinApproval
callback (Session::RegisterJoinApprovalCallback
) is called, allowing you to decide whether to accept or deny the request. If accepted into the session, JoinSessionOperation
is executed. If the request is denied, no operation executes, and a message is sent to the station attempting to join notifying it that its participation in the session has been denied. The JoinApproval
callback and JoinSessionOperation
executed after it are called by the station representing the connection point for the station attempting to connect.
When a station attempts to join a session the following sequence of events occurs:
・The JoinApproval
callback is executed.
・If the callback returns Approve
,
・The SessionOperationBegin
function is called.
・The Session
object executes the DuplicatedObject::Publish
function on the Station and the Station::State
changes to JoiningSession
.
・The connection point station sends a message to the station attempting to join to confirm that the join request has been accepted.
・The duplication master of the new Station object migrates (transfers duplicated object control) to the station attempting to join the session.
・The SessionOperation
End function is called.
・If the callback returns Deny
, the connection point informs the station attempting to join that participation is denied.
ApprovalState
|
Enumerator representing the possible return values of GetApprovalState . |
|
---|---|---|
Type
|
Enumerated type representing the types of operations called by the system. (Inherits Operation .) |
GetApprovalState
|
Gets the approval state of the request to join the current session. | |
---|---|---|
Approve
|
Approves the request to join the session. | |
Deny
|
Denies the request to join the session. | |
PostponeDecision
|
Postpones the decision regarding the request to join the session. | |
GetJoiningStation
|
Gets a pointer to the joining station. | |
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 using runtime information. (Inherits Operation .) |
S |
SetTraceFilter
|
Sets the callback function that specifies when to run traces on operation objects. (Inherits Operation .) |
nn::nex::RootObject
nn::nex::Operation
nn::nex::SessionOperation
nn::nex::JoinSessionOperation
CONFIDENTIAL