UPnPsdk::CNetadapter_platform Class Reference

Manage information from Unix like platforms about network adapters. More...

#include <netadapter_platform.hpp>

Inheritance diagram for UPnPsdk::CNetadapter_platform:

Collaboration diagram for UPnPsdk::CNetadapter_platform:

Public Member Functions
void	get_first () override
	Load a list of network adapters from the operating system and select its first entry.
bool	get_next () override
	Select next entry from the network adapter list that was initial loaded with get_first().
unsigned int	index () const override
	Get index number from current selected list entry.
std::string	name () const override
	Get network adapter name from current selected list entry.
void	sockaddr (SSockaddr &a_saddr) const override
	Get socket address from current selected list entry.
void	socknetmask (SSockaddr &a_snetmask) const override
	Get socket address netmask from current selected list entry.
unsigned int	bitmask () const override
	Get prefix length from the ip address of the current selected local network adapter.
void	get_first () override
	Load a list of network adapters from the operating system and select its first entry.
bool	get_next () override
	Select next entry from the network adapter list that was initial loaded with get_first().
unsigned int	index () const override
	Get index number from current selected list entry.
std::string	name () const override
	Get network adapter name from current selected list entry.
void	sockaddr (SSockaddr &a_saddr) const override
	Get socket address from current selected list entry.
void	socknetmask (SSockaddr &a_snetmask) const override
	Get socket address netmask from current selected list entry.
unsigned int	bitmask () const override
	Get prefix length from the ip address of the current selected local network adapter.

Protected Member Functions
void	reset () noexcept override
	Reset pointer and point to the first entry of the local network adapter list if available.

Detailed Description

Manage information from Unix like platforms about network adapters.

Manage information from Microsoft Windows about network adapters.

Definition at line 21 of file netadapter_platform.hpp.

Constructor & Destructor Documentation

CNetadapter_platform()

UPnPsdk::CNetadapter_platform::CNetadapter_platform

(

)

Definition at line 18 of file netadapter_unix.cpp.

~CNetadapter_platform()

UPnPsdk::CNetadapter_platform::~CNetadapter_platform ( )

virtual

Definition at line 22 of file netadapter_unix.cpp.

Member Function Documentation

get_first() [1/2]

void UPnPsdk::CNetadapter_platform::get_first ( )

overridevirtual

Load a list of network adapters from the operating system and select its first entry.

Exceptions

std::runtime_error

Failed to get information from the network adapters: (detail information appended)

Implements UPnPsdk::INetadapter.

Definition at line 27 of file netadapter_unix.cpp.

Here is the call graph for this function:

get_next() [1/2]

bool UPnPsdk::CNetadapter_platform::get_next ( )

overridevirtual

Select next entry from the network adapter list that was initial loaded with get_first().

Returns

• true if next adapter in the list exists
• false otherwise

Implements UPnPsdk::INetadapter.

Definition at line 43 of file netadapter_unix.cpp.

index() [1/2]

unsigned int UPnPsdk::CNetadapter_platform::index ( ) const

overridevirtual

Get index number from current selected list entry.

This is the unique number of a network adapter as given by the operating system. It is the best way to identify a network adapter. 0 means the unspecified, unavailable adapter.

Returns

• 0 if the local network adapter does not exist. This should only be possible if you haven't successful selected an adapter before.
• otherwise index number of the selected adapter.

Implements UPnPsdk::INetadapter.

Definition at line 57 of file netadapter_unix.cpp.

name() [1/2]

std::string UPnPsdk::CNetadapter_platform::name ( ) const

overridevirtual

Get network adapter name from current selected list entry.

Returns

• "" (empty string) if the local network adapter does not exist. This should only be possible if you haven't successful selected an adapter before.
• otherwise name of the local network adapter like "lo", "wlan0", "Ethernet". etc.

Implements UPnPsdk::INetadapter.

Definition at line 64 of file netadapter_unix.cpp.

sockaddr() [1/2]

void UPnPsdk::CNetadapter_platform::sockaddr ( SSockaddr &  a_saddr ) const

overridevirtual

Get socket address from current selected list entry.

Parameters

[in,out]

a_saddr

Reference to a socket address object that will be filled with the socket address from the current selected network adapter list entry.

Implements UPnPsdk::INetadapter.

Definition at line 80 of file netadapter_unix.cpp.

socknetmask() [1/2]

void UPnPsdk::CNetadapter_platform::socknetmask ( SSockaddr &  a_snetmask ) const

overridevirtual

Get socket address netmask from current selected list entry.

This netmask belongs to the adapters network address that is current selected.

Parameters

[in,out]

a_snetmask

Reference to a socket address object that will be filled with the socket address netmask from the current selected network adapter list entry.

Implements UPnPsdk::INetadapter.

Definition at line 91 of file netadapter_unix.cpp.

bitmask() [1/2]

unsigned int UPnPsdk::CNetadapter_platform::bitmask ( ) const

overridevirtual

Get prefix length from the ip address of the current selected local network adapter.

Returns

Prefix length of the ip address from the current selected local network adapter.

Implements UPnPsdk::INetadapter.

Definition at line 101 of file netadapter_unix.cpp.

Here is the call graph for this function:

reset()

void UPnPsdk::CNetadapter_platform::reset ( )

inlineoverrideprotectedvirtualnoexcept

Reset pointer and point to the first entry of the local network adapter list if available.

Implements UPnPsdk::INetadapter.

Definition at line 145 of file netadapter_unix.cpp.

Here is the caller graph for this function:

get_first() [2/2]

void UPnPsdk::CNetadapter_platform::get_first ( )

overridevirtual

Load a list of network adapters from the operating system and select its first entry.

Exceptions

std::runtime_error

Failed to get information from the network adapters: (detail information appended)

Implements UPnPsdk::INetadapter.

get_next() [2/2]

bool UPnPsdk::CNetadapter_platform::get_next ( )

overridevirtual

Select next entry from the network adapter list that was initial loaded with get_first().

Returns

• true if next adapter in the list exists
• false otherwise

Implements UPnPsdk::INetadapter.

index() [2/2]

unsigned int UPnPsdk::CNetadapter_platform::index ( ) const

overridevirtual

Get index number from current selected list entry.

This is the unique number of a network adapter as given by the operating system. It is the best way to identify a network adapter. 0 means the unspecified, unavailable adapter.

Returns

• 0 if the local network adapter does not exist. This should only be possible if you haven't successful selected an adapter before.
• otherwise index number of the selected adapter.

Implements UPnPsdk::INetadapter.

name() [2/2]

std::string UPnPsdk::CNetadapter_platform::name ( ) const

overridevirtual

Get network adapter name from current selected list entry.

Returns

• "" (empty string) if the local network adapter does not exist. This should only be possible if you haven't successful selected an adapter before.
• otherwise name of the local network adapter like "lo", "wlan0", "Ethernet". etc.

Implements UPnPsdk::INetadapter.

sockaddr() [2/2]

void UPnPsdk::CNetadapter_platform::sockaddr ( SSockaddr &  a_saddr ) const

overridevirtual

Get socket address from current selected list entry.

Parameters

[in,out]

a_saddr

Reference to a socket address object that will be filled with the socket address from the current selected network adapter list entry.

Implements UPnPsdk::INetadapter.

socknetmask() [2/2]

void UPnPsdk::CNetadapter_platform::socknetmask ( SSockaddr &  a_snetmask ) const

overridevirtual

Get socket address netmask from current selected list entry.

This netmask belongs to the adapters network address that is current selected.

Parameters

[in,out]

a_snetmask

Reference to a socket address object that will be filled with the socket address netmask from the current selected network adapter list entry.

Implements UPnPsdk::INetadapter.

bitmask() [2/2]

unsigned int UPnPsdk::CNetadapter_platform::bitmask ( ) const

overridevirtual

Get prefix length from the ip address of the current selected local network adapter.

Returns

Prefix length of the ip address from the current selected local network adapter.

Implements UPnPsdk::INetadapter.

---

The documentation for this class was generated from the following files:

• UPnPsdk/include/unix/UPnPsdk/netadapter_platform.hpp
• UPnPsdk/include/win32/UPnPsdk/netadapter_platform.hpp
• UPnPsdk/src/net/netadapter_unix.cpp
• UPnPsdk/src/net/netadapter_win32.cpp