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

Class that manages the CreateSession settings for networks using the UDS library (local communication). More...

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

Public Member Functions

 UdsCreateSessionSetting ()
 Instantiates an object.
 
virtual ~UdsCreateSessionSetting ()
 Destroys the object.
 
u16 GetMaxParticipants () const
 Gets the specified maximum number of participants. More...
 
u16 GetMinParticipants () const
 Gets the specified minimum number of participants. More...
 
virtual void SetLocalCreateNetworkSetting (const LocalCreateNetworkSetting &createNetworkSetting)
 Specifies the settings used when generating the network. More...
 
void SetMaxParticipants (u16 max)
 Sets the maximum number of participants for the session to create. More...
 
void SetMinParticipants (u16 min)
 Sets the minimum number of participants for the session to create. More...
 
nn::Result SetSignatureKey (const char *pSignatureKeyData, size_t signatureKeyDataSize)
 Sets the session key and its size. More...
 

Detailed Description

Class that manages the CreateSession settings for networks using the UDS library (local communication).


Revision History:
2014-03-03 Initial version.

Member Function Documentation

u16 nn::pia::session::CreateSessionSetting::GetMaxParticipants ( ) const
inlineinherited

Gets the specified maximum number of participants.

Returns
Returns the specified maximum number of participants.
u16 nn::pia::session::CreateSessionSetting::GetMinParticipants ( ) const
inlineinherited

Gets the specified minimum number of participants.

Returns
Returns the specified minimum number of participants.
virtual void nn::pia::local::UdsCreateSessionSetting::SetLocalCreateNetworkSetting ( const LocalCreateNetworkSetting createNetworkSetting)
virtual

Specifies the settings used when generating the network.

Parameters
[in]createNetworkSettingSettings used when the network is generated.

Implements nn::pia::local::LocalCreateSessionSetting.

void nn::pia::session::CreateSessionSetting::SetMaxParticipants ( u16  max)
inlineinherited

Sets the maximum number of participants for the session to create.

Parameters
[in]maxThe maximum number of participants specified for the session to create.
void nn::pia::session::CreateSessionSetting::SetMinParticipants ( u16  min)
inlineinherited

Sets the minimum number of participants for the session to create.

Parameters
[in]minThe minimum number of participants specified for the session to create.
nn::Result nn::pia::local::LocalCreateSessionSetting::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.