Fast DDS  Version 3.0.1
Fast DDS
Loading...
Searching...
No Matches
BlockedNetworkInterface Struct Reference

Structure extending NetworkInterface with information specific to blocked interfaces. More...

#include <BlockedNetworkInterface.hpp>

Inheritance diagram for BlockedNetworkInterface:

Public Member Functions

virtual FASTDDS_EXPORTED_API ~BlockedNetworkInterface ()=default
 Destructor.
 
FASTDDS_EXPORTED_API BlockedNetworkInterface (const BlockedNetworkInterface &iface)=default
 Copy constructor.
 
FASTDDS_EXPORTED_API BlockedNetworkInterfaceoperator= (const BlockedNetworkInterface &iface)=default
 Copy assignment.
 
FASTDDS_EXPORTED_API BlockedNetworkInterface (BlockedNetworkInterface &&iface)=default
 Move constructor.
 
FASTDDS_EXPORTED_API BlockedNetworkInterfaceoperator= (BlockedNetworkInterface &&iface)=default
 Move assignment.
 
FASTDDS_EXPORTED_API NetworkInterface (const std::string &name)
 Constructor by name.
 
FASTDDS_EXPORTED_API NetworkInterface (const std::string &device, const std::string &ip, const LocatorWithMask &locator)
 Constructor by device name, IP address string and locator with mask.
 
FASTDDS_EXPORTED_API NetworkInterface (const NetworkInterface &iface)=default
 Copy constructor.
 
FASTDDS_EXPORTED_API NetworkInterface (NetworkInterface &&iface)=default
 Move constructor.
 
- Public Member Functions inherited from NetworkInterface
FASTDDS_EXPORTED_API NetworkInterface (const std::string &name)
 Constructor by name.
 
FASTDDS_EXPORTED_API NetworkInterface (const std::string &device, const std::string &ip, const LocatorWithMask &locator)
 Constructor by device name, IP address string and locator with mask.
 
virtual FASTDDS_EXPORTED_API ~NetworkInterface ()=default
 Destructor.
 
FASTDDS_EXPORTED_API NetworkInterface (const NetworkInterface &iface)=default
 Copy constructor.
 
FASTDDS_EXPORTED_API NetworkInterfaceoperator= (const NetworkInterface &iface)=default
 Copy assignment.
 
FASTDDS_EXPORTED_API NetworkInterface (NetworkInterface &&iface)=default
 Move constructor.
 
FASTDDS_EXPORTED_API NetworkInterfaceoperator= (NetworkInterface &&iface)=default
 Move assignment.
 
FASTDDS_EXPORTED_API bool operator== (const NetworkInterface &iface) const
 Comparison operator.
 

Additional Inherited Members

- Public Attributes inherited from NetworkInterface
std::string name
 Interface device name or IP address in string format (to be filled by the user)
 
std::string device
 Interface device name.
 
std::string ip
 IP address in string format (includes scope ID in the IPv6 case)
 
LocatorWithMask locator
 IP address with network mask.
 

Detailed Description

Structure extending NetworkInterface with information specific to blocked interfaces.

Note
When using this structure to interact with Fast-DDS, name is the only attribute the user needs to provide. The rest of the attributes are internally filled, and are in fact ignored even if already provided by the user.

Constructor & Destructor Documentation

◆ ~BlockedNetworkInterface()

virtual FASTDDS_EXPORTED_API ~BlockedNetworkInterface ( )
virtualdefault

Destructor.

◆ BlockedNetworkInterface() [1/2]

FASTDDS_EXPORTED_API BlockedNetworkInterface ( const BlockedNetworkInterface iface)
default

Copy constructor.

◆ BlockedNetworkInterface() [2/2]

FASTDDS_EXPORTED_API BlockedNetworkInterface ( BlockedNetworkInterface &&  iface)
default

Move constructor.

Member Function Documentation

◆ NetworkInterface() [1/4]

FASTDDS_EXPORTED_API NetworkInterface ( const NetworkInterface iface)
default

Copy constructor.

◆ NetworkInterface() [2/4]

FASTDDS_EXPORTED_API NetworkInterface ( const std::string &  device,
const std::string &  ip,
const LocatorWithMask locator 
)

Constructor by device name, IP address string and locator with mask.

◆ NetworkInterface() [3/4]

FASTDDS_EXPORTED_API NetworkInterface ( const std::string &  name)

Constructor by name.

◆ NetworkInterface() [4/4]

FASTDDS_EXPORTED_API NetworkInterface ( NetworkInterface &&  iface)
default

Move constructor.

◆ operator=() [1/2]

FASTDDS_EXPORTED_API BlockedNetworkInterface & operator= ( BlockedNetworkInterface &&  iface)
default

Move assignment.

◆ operator=() [2/2]

FASTDDS_EXPORTED_API BlockedNetworkInterface & operator= ( const BlockedNetworkInterface iface)
default

Copy assignment.


The documentation for this struct was generated from the following file: