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

Class that holds information about networks that use the UDS library. More...

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

Public Member Functions

 UdsNetworkDescription ()
 The default constructor.
 
virtual void GetBssid (bit8 *pBssidBuffer) const
 Gets the BSSID (the host's MAC address). More...
 
virtual u16 GetChannel () const
 Gets the channel being used for the communication. More...
 
virtual u32 GetCurrentParticipants () const
 Gets the number of stations currently participating in the network. More...
 
virtual u32 GetMaxParticipants () const
 Gets the maximum number of stations that can participate in the network. More...
 
virtual u8 GetSubId () const
 Gets the ID for identifying the communication mode. More...
 
virtual bool IsOpened () const
 Gets whether the network allows participation. More...
 

Detailed Description

Class that holds information about networks that use the UDS library.


Revision History:
2014-03-03 Initial version.

Member Function Documentation

virtual void nn::pia::local::UdsNetworkDescription::GetBssid ( bit8 *  pBssidBuffer) const
inlinevirtual

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.

Parameters
[out]pBssidBufferBuffer that stores the BSSID. The size must be nn::uds::MAC_ADDRESS_SIZE bytes.

Implements nn::pia::local::LocalNetworkDescription.

virtual u16 nn::pia::local::UdsNetworkDescription::GetChannel ( ) const
inlinevirtual

Gets the channel being used for the communication.

There is normally no need to reference this.

Returns
Returns the channel being used for communication.

Implements nn::pia::local::LocalNetworkDescription.

virtual u32 nn::pia::local::UdsNetworkDescription::GetCurrentParticipants ( ) const
inlinevirtual

Gets the number of stations currently participating in the network.

The number of stations that can be obtained is the number at the point when the network is scanned.

Returns
Returns the number of stations participating in the network.

Implements nn::pia::local::LocalNetworkDescription.

virtual u32 nn::pia::local::UdsNetworkDescription::GetMaxParticipants ( ) const
inlinevirtual

Gets the maximum number of stations that can participate in the network.

Returns
Returns the maximum number of stations that can participate in the network.

Implements nn::pia::local::LocalNetworkDescription.

virtual u8 nn::pia::local::UdsNetworkDescription::GetSubId ( ) const
inlinevirtual

Gets the ID for identifying the communication mode.

Returns
Returns the ID for identifying the communication mode.

Implements nn::pia::local::LocalNetworkDescription.

virtual bool nn::pia::local::UdsNetworkDescription::IsOpened ( ) const
inlinevirtual

Gets whether the network allows participation.

The state that can be obtained is the state at the point when the network is scanned.

Returns
Returns whether the network allows participation.
See also
LocalNetwork::DisallowParticipating, LocalNetwork::AllowParticipating

Implements nn::pia::local::LocalNetworkDescription.