CTR Pia  4.11.3
Game Communication Engine
nn::pia::local::LocalJoinSessionSetting Class Referenceabstract

Base class that manages the settings for the JoinSession function with a LocalNetwork object. More...

+ Inheritance diagram for nn::pia::local::LocalJoinSessionSetting:

Public Member Functions

virtual void SetSessionInfoPtr (ISessionInfo *pSessionInfo)
 Sets target session information. More...
 
nn::Result SetSignatureKey (const char *pSignatureKeyData, size_t signatureKeyDataSize)
 Sets the session key and its size. More...
 

Detailed Description

Base class that manages the settings for the JoinSession function with a LocalNetwork object.

This class is never instantiated by an application. Use a class that inherits this class.

See also
nn::pia::local::UdsJoinSessionSetting


Revision History:

2014-05-28 Renamed the GetSessionId function to GetSessionId.

2014-04-30 Added the GetSessionId function.

2014-03-03 Initial version.

Member Function Documentation

virtual void nn::pia::session::JoinSessionSetting::SetSessionInfoPtr ( ISessionInfo pSessionInfo)
virtualinherited

Sets target session information.

Sets target session information. Set the session information that was found using Session::BrowseSessionAsync.

Parameters
[in]pSessionInfoThe target session's information.
See also
Session::JoinSessionAsync, Session::BrowseSessionAsync
nn::Result nn::pia::local::LocalJoinSessionSetting::SetSignatureKey ( const char *  pSignatureKeyData,
size_t  signatureKeyDataSize 
)

Sets the session key and its size.

Set the session key size to no more than common::SignatureSetting::SIGNATURE_KEY_DATA_SIZE_MAX.

Parameters
[in]pSignatureKeyDataThe session key.
[in]signatureKeyDataSizeThe size of the session key.
Returns
Returns a Result value for which the IsSuccess function returns true if execution succeeds.
Error Return Values:
ResultInvalidArgument Indicates that an argument is invalid. Programming error. Fix your program so that this error is not returned.