#include <LHNetworkConfigurationAPI.h>
|
virtual | ~LHNetworkConfigurationAPI ()=default |
|
virtual bool | getEthernetAddOnAvailable (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual void | getEthernetMACAddress (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_mac_address_array_t outMACAddress, size_t outMACAddressSize) |
|
virtual lh_ip_assign_mode_t | getIPAddressAssignedMode (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual void | getManualNetworkConfiguration (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_network_configuration_t &configuration) |
|
virtual void | getNetworkConfiguration (lh_device_id_t deviceID, lh_error_code_t *errorCode, bool &outManualAssignment, lh_network_configuration_t &configuration) |
|
virtual void | setIPAddressAssignedMode (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_ip_assign_mode_t mode) |
|
virtual void | setManualNetworkConfiguration (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_network_configuration_t &configuration) |
|
◆ ~LHNetworkConfigurationAPI()
virtual oceandirect::api::LHNetworkConfigurationAPI::~LHNetworkConfigurationAPI |
( |
| ) |
|
|
virtualdefault |
◆ getEthernetAddOnAvailable()
.getEthernetAddOnAvailable Determine if the device has an Ethernet add-on.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- true if the device has an Ethernet add-on, false otherwise.
◆ getEthernetMACAddress()
.getEthernetMACAddress Get the MAC address of the device.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
outMACAddress | the array where the retrieved MAC address will be stored. |
outMACAddressSize | the size of the array outMACAddress (6). |
◆ getIPAddressAssignedMode()
.getIPAddressAssignedMode Read the IP address mode from the device.
- See also
- setIPAddressAssignedMode()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- "manual" if the ip address was statically assigned, "automatic" if the ip address was generated via DHCP, or "manual" on error.
◆ getManualNetworkConfiguration()
.getManualNetworkConfiguration Get the (manually set) network configuration parameters for the device.
- See also
- setManualNetworkConfiguration()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
configuration | the network configuration parameters: ipv4Address 4 bytes (array) specifying the IP address; ipv4AddressSize the size of the array ipv4Address (4); subnetMask 4 bytes (array) specifying the subnet mask; subnetMaskSize the size of the array subnetMask (4); defaultGateway 4 bytes (array) specifying the default network gateway; defaultGatewaySize the size of the array defaultGateway (4); dnsServer 4 bytes (array) specifying the DNS server; dnsServerSize the size of the array dnsServer(4). |
◆ getNetworkConfiguration()
.getNetworkConfiguration Get the network configuration parameters for the device.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
outManualAssignment | true if the configuration was set manually, false otherwise. |
configuration | the network configuration parameters: ipv4Address 4 bytes (array) specifying the IP address; ipv4AddressSize the size of the array ipv4Address (4); subnetMask 4 bytes (array) specifying the subnet mask; subnetMaskSize the size of the array subnetMask (4); defaultGateway 4 bytes (array) specifying the default network gateway; defaultGatewaySize the size of the array defaultGateway (4); dnsServer 4 bytes (array) specifying the DNS server; dnsServerSize the size of the array dnsServer(4). |
◆ setIPAddressAssignedMode()
.setIPAddressAssignedMode Set the IP address mode for the device.
- See also
- getIPAddressAssignedMode()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
mode | set to lh_ip_assign_mode_t::manual if the IP address is assigned manually or lh_ip_assign_mode_t::automatic if the address is assigned by DHCP. |
◆ setManualNetworkConfiguration()
.setManualNetworkConfiguration Set the (manually set) network configuration parameters for the device.
- See also
- getManualNetworkConfiguration()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
configuration | the network configuration parameters: ipv4Address 4 bytes (array) specifying the IP address; ipv4AddressSize the size of the array ipv4Address (4); subnetMask 4 bytes (array) specifying the subnet mask; subnetMaskSize the size of the array subnetMask (4); defaultGateway 4 bytes (array) specifying the default network gateway; defaultGatewaySize the size of the array defaultGateway (4); dnsServer 4 bytes (array) specifying the DNS server; dnsServerSize the size of the array dnsServer(4). |
The documentation for this class was generated from the following file: