com.inscoper.api.EthernetConnectionConfig¶

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

Inherits from com.inscoper.api.ConnectionConfig

Public Functions¶

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

Protected Functions¶

	Name
	EthernetConnectionConfig(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(EthernetConnectionConfig obj)

Additional inherited members¶

Public Functions inherited from com.inscoper.api.ConnectionConfig

	Name
	ConnectionConfig() Constructor.
	ConnectionConfig(short tag) Constructor.
int	getTag() Get the tag of the current connection.
void	setTag(int tag) Set the tag of the current connection.
int	getRealType()
ConnectionConfig	createProxy(long cPtr, boolean cMemoryOwn)
AdvancedConnectionConfig	castToAdvancedConnectionConfig(ConnectionConfig connectionConfig)
USBConnectionConfig	castToUSBConnectionConfig(ConnectionConfig connectionConfig)
EthernetConnectionConfig	castToEthernetConnectionConfig(ConnectionConfig connectionConfig)

Protected Functions inherited from com.inscoper.api.ConnectionConfig

	Name
	ConnectionConfig(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.api.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 delete¶

public synchronized void delete()

Reimplements: com.inscoper.api.ConnectionConfig.delete

function EthernetConnectionConfig¶

public EthernetConnectionConfig()

Default constructor.

Initializes a new instance of the EthernetConnectionConfig class.

function fromXML¶

public void fromXML(
    XMLNode connectionNode
)

Provide Ethernet connection information from the XML node.

Parameters:

connectionNode : The XML node containing Ethernet connection information

Exceptions:

InscoperException If an error occurred

Reimplements: com.inscoper.api.ConnectionConfig.fromXML

Populates the Ethernet connection configuration from the provided XML node.

function toXML¶

public void toXML(
    XMLNode xmlParent
)

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: com.inscoper.api.ConnectionConfig.toXML

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

function getType¶

public EConnectionType getType()

Return the connection type.

Return: The type of the connection

Reimplements: com.inscoper.api.ConnectionConfig.getType

Retrieves the specific type of connection configuration (Ethernet).

function getServerClient¶

public short getServerClient()

Get the mode validation byte.

Return: The mode validation byte

Retrieves the server/client mode validation byte.

function setServerClient¶

public void setServerClient(
    short serverClient
)

Set the mode validation byte.

Parameters:

serverClient : The mode validation byte

Sets the server/client mode validation byte.

function getAddressType¶

public short getAddressType()

Get the IP addressing mode.

Return: The IP addressing mode

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

function setAddressType¶

public void setAddressType(
    short addressType
)

Set the IP addressing mode.

Parameters:

addressType : The IP addressing mode

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

function getIpAddress¶

public long getIpAddress()

Get the IP address.

Return: The IP address

Retrieves the IP address as an unsigned integer.

function setIpAddress¶

public void setIpAddress(
    long ipAddress
)

Set the IP address.

Parameters:

ipAddress : The IP address

Sets the IP address as an unsigned integer.

function getMask¶

public long getMask()

Get the subnet mask.

Return: The subnet mask

Retrieves the subnet mask as an unsigned integer.

function setMask¶

public void setMask(
    long mask
)

Set the subnet mask.

Parameters:

mask : The subnet mask

Sets the subnet mask as an unsigned integer.

function getGateWAddress¶

public long getGateWAddress()

Get the gateway address.

Return: The gateway address

Retrieves the gateway address as an unsigned integer.

function setGateWAddress¶

public void setGateWAddress(
    long gateWAddress
)

Set the gateway address.

Parameters:

gateWAddress : The gateway address

Sets the gateway address as an unsigned integer.

function getPort¶

public int getPort()

Get the connection port.

Return: The connection port

Retrieves the network port number.

function setPort¶

public void setPort(
    int port
)

Set the connection port.

Parameters:

port : The port

Sets the network port number.

Protected Functions Documentation¶

function EthernetConnectionConfig¶

protected EthernetConnectionConfig(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.api.ConnectionConfig.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.api.ConnectionConfig.finalize

function getCPtr¶

protected static long getCPtr(
    EthernetConnectionConfig obj
)

Updated on 2026-09-03 at 12:14:19 +0200