CTR Pia
4.11.3
Game Communication Engine
|
Data class for Internet communication sessions. More...
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::DateTime & | GetStartedTime () 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... | |
Data class for Internet communication sessions.
|
virtual |
Copies session information.
Use this when you want the application to retain session information.
[in] | rhs | Session information to copy. |
|
virtual |
Gets the session's application-defined data.
Gets the application-defined data configured for the session.
[out] | pBuffer | Pointer to the buffer for copying the session's application-defined data. |
[in] | size | Specifies the size of the buffer required for copying the session's application-defined data. |
Result
value indicating success if information was successfully obtained. 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 |
Gets the length of the session's application-defined data.
|
virtual |
Gets the session's attributes.
[out] | pAttribute | Pointer to the attribute container for the session for the specified index. |
[in] | idx | Specifies the index for the attribute to get. |
Result
value indicating success if information was successfully obtained. 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 |
Gets the number of people participating in a session.
Implements nn::pia::session::ISessionInfo.
|
virtual |
Gets the session's description string.
[out] | pBuffer | Pointer to the buffer for copying the session's description string. |
[in] | size | Size of the buffer for copying the session's description string. |
Result
value indicating success if information was successfully obtained. 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 |
Gets the length of the session's description string.
|
virtual |
Gets the session's game mode.
Implements nn::pia::session::ISessionInfo.
|
virtual |
Gets the principal ID of the session host.
|
virtual |
Gets the maximum number of people who can participate in a session.
Implements nn::pia::session::ISessionInfo.
|
virtual |
Gets the minimum number of people who can participate in a session.
Implements nn::pia::session::ISessionInfo.
|
virtual |
Gets the matchmaking priority for the session.
|
virtual |
|
virtual |
Gets the session type.
|
virtual |
Gets the clock to use when the session begins.
|
virtual |
Gets the principal ID specified in the session search conditions.
|
virtual |
Gets whether a session is open for recruitment.
true
if the session is open for recruitment, and returns false
if it is closed. Implements nn::pia::session::ISessionInfo.
|
virtual |
Checks whether a user password is set for the session.
true
if a user password is set.
|
virtual |
Prints information that is useful for debugging.
[in] | flag | Specifies the bitwise OR of trace flags. For more information, see the TraceFlag API reference. |
Implements nn::pia::session::ISessionInfo.