CTR Pia  4.11.3
Game Communication Engine
nn::pia::inet::NexSessionInfo Class Reference

Data class for Internet communication sessions. More...

+ Inheritance diagram for nn::pia::inet::NexSessionInfo:

Public Member Functions

virtual void Clear ()
 Clears session information.
 
virtual void Copy (const NexSessionInfo &rhs)
 Copies session information. More...
 
virtual nn::Result GetApplicationDataBuf (void *pBuffer, size_t size)
 Gets the session's application-defined data. More...
 
virtual size_t GetApplicationDataSize () const
 Gets the length of the session's application-defined data. More...
 
virtual nn::Result GetAttribute (u32 *pAttribute, u8 idx) const
 Gets the session's attributes. More...
 
virtual u32 GetCurrentParticipants () const
 Gets the number of people participating in a session. More...
 
virtual nn::Result GetDescription (wchar_t *pBuffer, size_t size) const
 Gets the session's description string. More...
 
virtual size_t GetDescriptionSize () const
 Gets the length of the session's description string. More...
 
virtual u32 GetGameMode () const
 Gets the session's game mode. More...
 
virtual u32 GetHostPrincipalId () const
 Gets the principal ID of the session host. More...
 
virtual u32 GetMaxParticipants () const
 Gets the maximum number of people who can participate in a session. More...
 
virtual u32 GetMinParticipants () const
 Gets the minimum number of people who can participate in a session. More...
 
virtual u8 GetSelectionPriority () const
 Gets the matchmaking priority for the session. More...
 
virtual u32 GetSessionId () const
 Gets the session's ID. More...
 
virtual SessionType GetSessionType () const
 Gets the session type. More...
 
virtual const common::DateTimeGetStartedTime () const
 Gets the clock to use when the session begins. More...
 
virtual u32 GetTargetPrincipalId () const
 Gets the principal ID specified in the session search conditions. More...
 
virtual bool IsOpened () const
 Gets whether a session is open for recruitment. More...
 
virtual bool IsRestrictedByUserPassword () const
 Checks whether a user password is set for the session. More...
 
virtual void Trace (u64 flag)
 Prints information that is useful for debugging. More...
 

Detailed Description

Data class for Internet communication sessions.

Member Function Documentation

virtual void nn::pia::inet::NexSessionInfo::Copy ( const NexSessionInfo rhs)
virtual

Copies session information.

Use this when you want the application to retain session information.

Parameters
[in]rhsSession information to copy.
virtual nn::Result nn::pia::inet::NexSessionInfo::GetApplicationDataBuf ( void *  pBuffer,
size_t  size 
)
virtual

Gets the session's application-defined data.

Gets the application-defined data configured for the session.

Parameters
[out]pBufferPointer to the buffer for copying the session's application-defined data.
[in]sizeSpecifies the size of the buffer required for copying the session's application-defined data.
Returns
Returns a Result value indicating success if information was successfully obtained.
Error Return Values:

ResultInvalidArgument Indicates that an argument is invalid. Programming error. Fix your program so that this error is not returned.

ResultInvalidState Not in a state where data can be retrieved. Programming error. Fix your program so that this error is not returned.

virtual size_t nn::pia::inet::NexSessionInfo::GetApplicationDataSize ( ) const
virtual

Gets the length of the session's application-defined data.

Returns
Returns the length of the session's application-defined data.
virtual nn::Result nn::pia::inet::NexSessionInfo::GetAttribute ( u32 *  pAttribute,
u8  idx 
) const
virtual

Gets the session's attributes.

Parameters
[out]pAttributePointer to the attribute container for the session for the specified index.
[in]idxSpecifies the index for the attribute to get.
Returns
Returns a Result value indicating success if information was successfully obtained.
Error Return Values:

ResultInvalidArgument Indicates that an argument is invalid. Programming error. Fix your program so that this error is not returned.

ResultInvalidState Not in a state where data can be retrieved. Programming error. Fix your program so that this error is not returned.

virtual u32 nn::pia::inet::NexSessionInfo::GetCurrentParticipants ( ) const
virtual

Gets the number of people participating in a session.

Returns
Returns the number of people participating in a session.

Implements nn::pia::session::ISessionInfo.

virtual nn::Result nn::pia::inet::NexSessionInfo::GetDescription ( wchar_t *  pBuffer,
size_t  size 
) const
virtual

Gets the session's description string.

Parameters
[out]pBufferPointer to the buffer for copying the session's description string.
[in]sizeSize of the buffer for copying the session's description string.
Returns
Returns a Result value indicating success if information was successfully obtained.
Error Return Values:

ResultInvalidArgument Indicates that an argument is invalid. Programming error. Fix your program so that this error is not returned.

ResultInvalidState Not in a state where data can be retrieved. Programming error. Fix your program so that this error is not returned.

virtual size_t nn::pia::inet::NexSessionInfo::GetDescriptionSize ( ) const
virtual

Gets the length of the session's description string.

Returns
Returns the length of the session's description string.
virtual u32 nn::pia::inet::NexSessionInfo::GetGameMode ( ) const
virtual

Gets the session's game mode.

Returns
Returns the session's game mode.

Implements nn::pia::session::ISessionInfo.

virtual u32 nn::pia::inet::NexSessionInfo::GetHostPrincipalId ( ) const
virtual

Gets the principal ID of the session host.

Returns
Returns the principal ID of the session host.
virtual u32 nn::pia::inet::NexSessionInfo::GetMaxParticipants ( ) const
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.

Implements nn::pia::session::ISessionInfo.

virtual u32 nn::pia::inet::NexSessionInfo::GetMinParticipants ( ) const
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.

Implements nn::pia::session::ISessionInfo.

virtual u8 nn::pia::inet::NexSessionInfo::GetSelectionPriority ( ) const
virtual

Gets the matchmaking priority for the session.

Returns
Returns the matchmaking priority for the session.
virtual u32 nn::pia::inet::NexSessionInfo::GetSessionId ( ) const
virtual

Gets the session's ID.

Returns
Returns the session ID.

Implements nn::pia::session::ISessionInfo.

virtual SessionType nn::pia::inet::NexSessionInfo::GetSessionType ( ) const
virtual

Gets the session type.

Returns
Returns the configured session type.
virtual const common::DateTime& nn::pia::inet::NexSessionInfo::GetStartedTime ( ) const
virtual

Gets the clock to use when the session begins.

Returns
Returns the clock to use when the session begins.
virtual u32 nn::pia::inet::NexSessionInfo::GetTargetPrincipalId ( ) const
virtual

Gets the principal ID specified in the session search conditions.

Returns
Returns the principal ID specified in the session search conditions.
virtual bool nn::pia::inet::NexSessionInfo::IsOpened ( ) const
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.

Implements nn::pia::session::ISessionInfo.

virtual bool nn::pia::inet::NexSessionInfo::IsRestrictedByUserPassword ( ) const
virtual

Checks whether a user password is set for the session.

Returns
Returns true if a user password is set.
virtual void nn::pia::inet::NexSessionInfo::Trace ( u64  flag)
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.

Implements nn::pia::session::ISessionInfo.