CTR Pia
4.11.3
Game Communication Engine
|
Data class for local communication sessions. More...
Public Member Functions | |
virtual void | Clear () |
Clears session information. | |
virtual nn::Result | GetApplicationDataBuf (void *pBuffer, size_t size)=0 |
Gets the session's application-defined data. More... | |
virtual nn::Result | GetApplicationDataSize (size_t *pSize)=0 |
Gets the length of the session's application-defined data. More... | |
virtual nn::Result | GetBssid (bit8 *pBssidBuffer) const =0 |
Gets the BSSID (the host's MAC address). More... | |
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 |
Gets the minimum number of people who can participate in a session. More... | |
virtual nn::Result | GetRadioStrength (u8 *pRadioStrength) const |
Gets the session's signal strength. More... | |
virtual u32 | GetSessionId () const =0 |
Gets the session's ID. More... | |
virtual nn::Result | GetSessionStationInfo (session::SessionStationInfo *pSessionStationInfo) const =0 |
Gets the information for stations currently participating in sessions. 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... | |
Data class for local communication sessions.
|
pure virtual |
Gets the session's application-defined data.
Gets the beacon data set by the application.
[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.
ResultNoData
There was no data to get. Handle appropriately in the application.
Implemented in nn::pia::local::UdsSessionInfo.
|
pure virtual |
Gets the length of the session's application-defined data.
[out] | pSize | Pointer to the container for the length of 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.
Implemented in nn::pia::local::UdsSessionInfo.
|
pure virtual |
Gets the BSSID (the host's MAC address).
The size of the BSSID is nn::uds::MAC_ADDRESS_SIZE
bytes. Set a buffer of this size in the parameter.
[out] | pBssidBuffer | Buffer that stores the BSSID. The size must be nn::uds::MAC_ADDRESS_SIZE bytes. |
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.
Implemented in nn::pia::local::UdsSessionInfo.
|
pure virtualinherited |
Gets the number of people participating in a session.
Implemented in nn::pia::local::UdsSessionInfo, and nn::pia::inet::NexSessionInfo.
|
pure virtualinherited |
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.
Implemented in nn::pia::local::UdsSessionInfo, and nn::pia::inet::NexSessionInfo.
|
pure virtualinherited |
Gets the maximum number of people who can participate in a session.
Implemented in nn::pia::local::UdsSessionInfo, and nn::pia::inet::NexSessionInfo.
|
virtual |
Gets the minimum number of people who can participate in a session.
Implements nn::pia::session::ISessionInfo.
|
virtual |
Gets the session's signal strength.
[out] | pRadioStrength | Pointer to the signal strength container. |
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.
|
pure virtualinherited |
Gets the session's ID.
Implemented in nn::pia::local::UdsSessionInfo, and nn::pia::inet::NexSessionInfo.
|
pure virtual |
Gets the information for stations currently participating in sessions.
Succeeds only when local communication is ongoing.
[out] | pSessionStationInfo | Specifies a pointer to the station information container. |
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.
ResultNoData
Indicates that information could not be obtained. Returned only during local communications. Handle appropriately in the application.
ResultInvalidConnection
Indicates that the device entered wireless off mode. You must restart. Returned only during local communications. Perform cleanup.
Implemented in nn::pia::local::UdsSessionInfo.
|
pure virtualinherited |
Gets whether a session is open for recruitment.
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.
|
pure virtualinherited |
Prints information that is useful for debugging.
[in] | flag | Specifies 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.