Functions |
| ceth_device * | CCEthernet::Alloc (int number) |
| | Device struct allocation. This function will allocate space for a given number of ceth_devices. You MUST Alloc() space for at least as many devices as you desire to find.
|
| void | CCEthernet::Free (ceth_device *list) |
| | Device struct de-allocation. You MUST free the memory allocated by Alloc() when you are done.
|
| int | CCEthernet::find_devices (ceth_device_type type, int number, ceth_device *list) |
| | This function broadcasts a request for all devices to identify themselves. A udp broadcast is sent out on a special port that SeaIO devices will answer to responding with a package of device specific information including IP, NetMask, Gateway, and DHCP Name. This function will then attempt to retrieve all the MAC addresses for the found devices. Retrieving the MAC Addresses is a privileged operation and will gracefully fail reporting a MAC of 00:00:00:00:00:00.
|
| int | CCEthernet::set_information (ceth_device *device, ceth_set_types command,...) |
| | Set a device's Ethernet configuration. This function can be used to change a device's DHCP name, IP, NetMask, and Gateway. You may also use this function to set a device to DHCP, IF it is still on your local subnet. If the device is no longer on your subnet, you may use the recover_module() function to re-enable DHCP mode. When you use the command SetIPAddress, you must supply IP, NetMask, and Gateway ceth_ip_address structs. Error checking will determine if you supply invalid IP and NetMask. ie a broadcast/home IP or nonstandard netmask.
|
| int | CCEthernet::recover_module (ceth_device *device) |
| | Use this function to recover a device not on your subnet. This function is designed to re-enable DHCP on a device that has been removed from your subnet by a SetIPAddress command. Since you can no longer send commands to a device that is no longer on your subnet, it is helpful to be able to re-enable DHCP so that you may once again. NOTE: This function requires use of the MAC address and is therefore a privileged (RAW Socket) function. You may alternatively hard code the device's MAC address into the ceth_device struct provided to this function.
|
Detailed Description
This is a C++ wrapper for the standard CEthernet library. This library is designed to aid in the discovery and configuration of Ethernet enabled SeaIO modules.