Inscoper::EthernetConnectionConfig¶

EthernetConnectionConfig class provides required information for Ethernet devices configuration. More...

#include <EthernetConnectionConfig.h>

Inherits from Inscoper::ConnectionConfig

Public Functions¶

	Name
	EthernetConnectionConfig() Default constructor.
virtual void	fromXML(Inscoper::XMLNode & connectionNode) override Provide Ethernet connection information from the XML node.
virtual void	toXML(Inscoper::XMLNode & xmlParent) override Export Ethernet connection information in an XML node attached to the parent XML node.
virtual Inscoper::EConnectionType	getType() override Return the connection type.
unsigned char	getServerClient() const Get the mode validation byte.
void	setServerClient(unsigned char serverClient) Set the mode validation byte.
unsigned char	getAddressType() const Get the IP addressing mode.
void	setAddressType(unsigned char addressType) Set the IP addressing mode.
unsigned int	getIpAddress() const Get the IP address.
void	setIpAddress(unsigned int ipAddress) Set the IP address.
unsigned int	getMask() const Get the subnet mask.
void	setMask(unsigned int mask) Set the subnet mask.
unsigned int	getGateWAddress() const Get the gateway address.
void	setGateWAddress(unsigned int gateWAddress) Set the gateway address.
unsigned short	getPort() const Get the connection port.
void	setPort(unsigned short port) Set the connection port.

Additional inherited members¶

Public Functions inherited from Inscoper::ConnectionConfig

	Name
	ConnectionConfig() Constructor.
	ConnectionConfig(unsigned char tag) Constructor.
virtual	~ConnectionConfig() Default destructor.
unsigned short	getTag() const Get the tag of the current connection.
void	setTag(unsigned short tag) Set the tag of the current connection.

Detailed Description¶

class Inscoper::EthernetConnectionConfig;

EthernetConnectionConfig class provides required information for Ethernet devices configuration.

Note: This class is non-copyable and non-movable.

This class extends ConnectionConfig to manage network-specific settings such as IP address, subnet mask, gateway, and port configuration for Ethernet-connected devices.

Public Functions Documentation¶

function EthernetConnectionConfig¶

EthernetConnectionConfig()

Default constructor.

Initializes a new instance of the EthernetConnectionConfig class.

function fromXML¶

virtual void fromXML(
    Inscoper::XMLNode & connectionNode
) override

Provide Ethernet connection information from the XML node.

Parameters:

connectionNode : The XML node containing Ethernet connection information

Exceptions:

InscoperException If an error occurred

Reimplements: Inscoper::ConnectionConfig::fromXML

Populates the Ethernet connection configuration from the provided XML node.

function toXML¶

virtual void toXML(
    Inscoper::XMLNode & xmlParent
) override

Export Ethernet connection information in an XML node attached to the parent XML node.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException If an error occurred

Reimplements: Inscoper::ConnectionConfig::toXML

Serializes the Ethernet connection configuration to the specified parent XML node.

function getType¶

virtual Inscoper::EConnectionType getType() override

Return the connection type.

Return: The type of the connection

Reimplements: Inscoper::ConnectionConfig::getType

Retrieves the specific type of connection configuration (Ethernet).

function getServerClient¶

unsigned char getServerClient() const

Get the mode validation byte.

Return: The mode validation byte

Retrieves the server/client mode validation byte.

function setServerClient¶

void setServerClient(
    unsigned char serverClient
)

Set the mode validation byte.

Parameters:

serverClient : The mode validation byte

Sets the server/client mode validation byte.

function getAddressType¶

unsigned char getAddressType() const

Get the IP addressing mode.

Return: The IP addressing mode

Retrieves the mode of IP addressing (Static, DHCP).

function setAddressType¶

void setAddressType(
    unsigned char addressType
)

Set the IP addressing mode.

Parameters:

addressType : The IP addressing mode

Sets the mode of IP addressing (Static, DHCP).

function getIpAddress¶

unsigned int getIpAddress() const

Get the IP address.

Return: The IP address

Retrieves the IP address as an unsigned integer.

function setIpAddress¶

void setIpAddress(
    unsigned int ipAddress
)

Set the IP address.

Parameters:

ipAddress : The IP address

Sets the IP address as an unsigned integer.

function getMask¶

unsigned int getMask() const

Get the subnet mask.

Return: The subnet mask

Retrieves the subnet mask as an unsigned integer.

function setMask¶

void setMask(
    unsigned int mask
)

Set the subnet mask.

Parameters:

mask : The subnet mask

Sets the subnet mask as an unsigned integer.

function getGateWAddress¶

unsigned int getGateWAddress() const

Get the gateway address.

Return: The gateway address

Retrieves the gateway address as an unsigned integer.

function setGateWAddress¶

void setGateWAddress(
    unsigned int gateWAddress
)

Set the gateway address.

Parameters:

gateWAddress : The gateway address

Sets the gateway address as an unsigned integer.

function getPort¶

unsigned short getPort() const

Get the connection port.

Return: The connection port

Retrieves the network port number.

function setPort¶

void setPort(
    unsigned short port
)

Set the connection port.

Parameters:

port : The port

Sets the network port number.

Updated on 2026-04-02 at 10:55:36 +0200