CTR Pia  4.11.3
Game Communication Engine
nn::pia::local::UdsJoinSessionSetting Class Reference

Class that manages JoinSession settings in LocalNetwork sessions. More...

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

Public Member Functions

 UdsJoinSessionSetting ()
 Instantiates an object.
 
virtual ~UdsJoinSessionSetting ()
 Destroys the object.
 
virtual nn::Result SetPassphrase (const char *pPassphrase, size_t passphraseSize)
 Sets the passphrase used for encrypting the wireless layer and its size. More...
 
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...
 

Static Public Attributes

static const size_t PASSPHRASE_LENGTH_MAX = nn::uds::UDS_PASSPHRASE_LENGTH_MAX
 Specifies the maximum size of the passphrase used to encrypt the wireless layer.
 
static const size_t PASSPHRASE_LENGTH_MIN = nn::uds::UDS_PASSPHRASE_LENGTH_MIN
 Specifies the minimum size of the passphrase used to encrypt the wireless layer.
 

Detailed Description

Class that manages JoinSession settings in LocalNetwork sessions.


Revision History:
2014-03-03 Initial version.

Member Function Documentation

virtual nn::Result nn::pia::local::UdsJoinSessionSetting::SetPassphrase ( const char *  pPassphrase,
size_t  passphraseSize 
)
virtual

Sets the passphrase used for encrypting the wireless layer and its size.

Set the size of the passphrase to a value of at least PASSPHRASE_LENGTH_MIN but no more than PASSPHRASE_LENGTH_MAX.

Parameters
[in]pPassphraseSpecifies the passphrase to use for wireless layer encryption.
[in]passphraseSizeSpecifies the size of the passphrase to use for wireless layer encryption.
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.

Implements nn::pia::local::LocalJoinSessionSetting.

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 
)
inherited

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.