sbgECom
1.11.920-stable
|
This file implements SbgECom commands related to Ethernet configuration. More...
#include "sbgEComCmdCommon.h"
Go to the source code of this file.
Data Structures | |
struct | _SbgEComEthernetConf |
Typedefs | |
typedef enum _SbgEComEthernetMode | SbgEComEthernetMode |
typedef struct _SbgEComEthernetConf | SbgEComEthernetConf |
Enumerations | |
enum | _SbgEComEthernetMode { SBG_ECOM_ETHERNET_DHCP = 0, SBG_ECOM_ETHERNET_STATIC = 1 } |
Functions | |
SbgErrorCode | sbgEComEthernetGetConf (SbgEComHandle *pHandle, SbgEComEthernetConf *pEthernetConf) |
SbgErrorCode | sbgEComEthernetSetConf (SbgEComHandle *pHandle, const SbgEComEthernetConf *pEthernetConf) |
SbgErrorCode | sbgEComEthernetInfo (SbgEComHandle *pHandle, SbgEComEthernetConf *pEthernetConf) |
This file implements SbgECom commands related to Ethernet configuration.
Copyright (C) 2007-2016, SBG Systems SAS. All rights reserved.
This source code is intended for use only by SBG Systems SAS and those that have explicit written permission to use it from SBG Systems SAS.
THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
typedef enum _SbgEComEthernetMode SbgEComEthernetMode |
Enum that defines the different type of IP acquisition method.
typedef struct _SbgEComEthernetConf SbgEComEthernetConf |
Structure that contains all Ethernet configuration or settings.
enum _SbgEComEthernetMode |
SbgErrorCode sbgEComEthernetGetConf | ( | SbgEComHandle * | pHandle, |
SbgEComEthernetConf * | pEthernetConf | ||
) |
Get the configuration for the Ethernet interface. Warning: this method only returns the Ethernet configuration and NOT the ip address currently used by the device. You should rather use sbgEComEthernetInfo to retreive the current assigned IP.
[in] | pHandle | A valid sbgECom handle. |
[out] | pEthernetConf | Poiner to a SbgEComEthernetConf struct that holds the read configuration from the device. |
SbgErrorCode sbgEComEthernetSetConf | ( | SbgEComHandle * | pHandle, |
const SbgEComEthernetConf * | pEthernetConf | ||
) |
Set the configuration for the Ethernet interface.
[in] | pHandle | A valid sbgECom handle. |
[in] | pEthernetConf | Poiner to a SbgEComEthernetConf struct that holds the new configuration to apply. |
SbgErrorCode sbgEComEthernetInfo | ( | SbgEComHandle * | pHandle, |
SbgEComEthernetConf * | pEthernetConf | ||
) |
Get the current assigned and used IP address as well as network inforamtion. In opposition to sbgEComEthernetGetConf, this method will not return the Ethernet configuration. It will rather return the IP address currently used by the device.
[in] | pHandle | A valid sbgECom handle. |
[out] | pEthernetConf | Poiner to a SbgEComEthernetConf struct that holds the read IP settings from the device. |