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

The search condition class used when searching for a matchmaking session using LocalNetwork. More...

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

Public Member Functions

u16 GetMaxParticipantsRangeMax () const
 Gets the maximum value of the range of maximum participants set by the search criteria. More...
 
u16 GetMaxParticipantsRangeMin () const
 Gets the minimum value of the range of maximum participants set by the search criteria. More...
 
void SetLocalCommunicationId (u32 localCommunicationId)
 Sets the local communication ID. More...
 
void SetMaxParticipants (u16 max)
 Sets the maximum participants in the search criteria. More...
 
void SetMaxParticipantsRange (u16 min, u16 max)
 Sets a range of maximum participants in the search criteria. More...
 
void SetOpenedOnly (bool bOpenedOnly)
 Sets whether to search only for sessions that are open to participants in the search criteria. More...
 
virtual void SetResultRange (u32 offset, u32 size)
 Specifies the range of search results to get. More...
 
void SetSubId (u8 subId)
 Sets the ID for identifying the communication mode. To search all IDs, specify 0xff. More...
 
void SetVacantOnly (bool bVacantOnly)
 Sets whether to search only for sessions that have openings in the search criteria. More...
 

Detailed Description

The search condition class used when searching for a matchmaking session using LocalNetwork.


Revision History:
2014-03-03 Initial version.
See also
nn::pia::session::SessionSearchCriteria

Member Function Documentation

u16 nn::pia::local::LocalSessionSearchCriteria::GetMaxParticipantsRangeMax ( ) const
inline

Gets the maximum value of the range of maximum participants set by the search criteria.

Returns
Returns the maximum value of the range of maximum participants set by the search criteria.
u16 nn::pia::local::LocalSessionSearchCriteria::GetMaxParticipantsRangeMin ( ) const
inline

Gets the minimum value of the range of maximum participants set by the search criteria.

Returns
Returns the minimum value of the range of maximum participants set by the search criteria.
void nn::pia::local::LocalSessionSearchCriteria::SetLocalCommunicationId ( u32  localCommunicationId)
inline

Sets the local communication ID.

Specifies the value generated by LocalNetwork::CreateLocalCommunicationId.

Parameters
[in]localCommunicationIdSpecifies the local communication ID.
void nn::pia::local::LocalSessionSearchCriteria::SetMaxParticipants ( u16  max)
inline

Sets the maximum participants in the search criteria.

Parameters
[in]maxThe maximum participants value to set in the search criteria.
void nn::pia::local::LocalSessionSearchCriteria::SetMaxParticipantsRange ( u16  min,
u16  max 
)
inline

Sets a range of maximum participants in the search criteria.

Parameters
[in]minThe minimum value of the range to set for maximum participants in the search criteria.
[in]maxThe maximum value of the range to set for maximum participants in the search criteria.
void nn::pia::local::LocalSessionSearchCriteria::SetOpenedOnly ( bool  bOpenedOnly)
inline

Sets whether to search only for sessions that are open to participants in the search criteria.

Parameters
[in]bOpenedOnlySpecify true to search only for sessions that are open to participants.
virtual void nn::pia::session::SessionSearchCriteria::SetResultRange ( u32  offset,
u32  size 
)
inlinevirtualinherited

Specifies the range of search results to get.

If you specify 0xFFFFFFFF for the offset only during Internet communication, the search results will be sorted randomly and it will get the specified number of entries.

Parameters
[in]offsetStarting position of the entries to get as search results from the list of entries that match the search criteria.
[in]sizeNumber of entries to get as search results from the list of entries that match the search criteria.
void nn::pia::local::LocalSessionSearchCriteria::SetSubId ( u8  subId)
inline

Sets the ID for identifying the communication mode. To search all IDs, specify 0xff.

Parameters
[in]subIdSpecifies an ID for identifying the communication mode.
void nn::pia::local::LocalSessionSearchCriteria::SetVacantOnly ( bool  bVacantOnly)
inline

Sets whether to search only for sessions that have openings in the search criteria.

Parameters
[in]bVacantOnlySpecify true to search only for sessions that have openings.