CTR Pia  4.11.3
Game Communication Engine
nn::pia::session::ISessionInfo Class Referenceabstract

An interface to the session's information. More...

+ Inheritance diagram for nn::pia::session::ISessionInfo:

Public Member Functions

virtual void Clear ()=0
 Clears session information.
 
virtual u32 GetCurrentParticipants () const =0
 Gets the number of people participating in a session. More...
 
virtual u32 GetGameMode () const =0
 Gets the session's game mode. More...
 
virtual u32 GetMaxParticipants () const =0
 Gets the maximum number of people who can participate in a session. More...
 
virtual u32 GetMinParticipants () const =0
 Gets the minimum number of people who can participate in a session. More...
 
virtual u32 GetSessionId () const =0
 Gets the session's ID. More...
 
virtual bool IsOpened () const =0
 Gets whether a session is open for recruitment. More...
 
virtual void Trace (u64 flag)=0
 Prints information that is useful for debugging. More...
 

Detailed Description

An interface to the session's information.

Member Function Documentation

virtual u32 nn::pia::session::ISessionInfo::GetCurrentParticipants ( ) const
pure virtual

Gets the number of people participating in a session.

Returns
Returns the number of people participating in a session.

Implemented in nn::pia::local::UdsSessionInfo, and nn::pia::inet::NexSessionInfo.

virtual u32 nn::pia::session::ISessionInfo::GetGameMode ( ) const
pure virtual

Gets the session's game mode.

Returns a game mode value when Internet communication is ongoing.
During local communications, a communication mode ID is cast as a u32 argument and returned.

Returns
Returns the session's game mode.

Implemented in nn::pia::local::UdsSessionInfo, and nn::pia::inet::NexSessionInfo.

virtual u32 nn::pia::session::ISessionInfo::GetMaxParticipants ( ) const
pure virtual

Gets the maximum number of people who can participate in a session.

Returns
Returns the maximum number of people who can participate in a session.

Implemented in nn::pia::local::UdsSessionInfo, and nn::pia::inet::NexSessionInfo.

virtual u32 nn::pia::session::ISessionInfo::GetMinParticipants ( ) const
pure virtual

Gets the minimum number of people who can participate in a session.

Returns
Returns the minimum number of people who can participate in a session.

Implemented in nn::pia::inet::NexSessionInfo, and nn::pia::local::LocalSessionInfo.

virtual u32 nn::pia::session::ISessionInfo::GetSessionId ( ) const
pure virtual

Gets the session's ID.

Returns
Returns the session ID.

Implemented in nn::pia::local::UdsSessionInfo, and nn::pia::inet::NexSessionInfo.

virtual bool nn::pia::session::ISessionInfo::IsOpened ( ) const
pure virtual

Gets whether a session is open for recruitment.

Returns
Returns true if the session is open for recruitment, and returns false if it is closed.

Implemented in nn::pia::local::UdsSessionInfo, and nn::pia::inet::NexSessionInfo.

virtual void nn::pia::session::ISessionInfo::Trace ( u64  flag)
pure virtual

Prints information that is useful for debugging.

Parameters
[in]flagSpecifies the bitwise OR of trace flags. For more information, see the TraceFlag API reference.

Implemented in nn::pia::inet::NexSessionInfo, and nn::pia::local::UdsSessionInfo.