sbgEComCmdEthernet.h File Reference

This file implements SbgECom commands related to Ethernet configuration. More...

#include "sbgEComCmdCommon.h"

Include dependency graph for sbgEComCmdEthernet.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_SbgEComEthernetConf

Typedefs
typedef struct _SbgEComEthernetConf	SbgEComEthernetConf
typedef enum _SbgEComEthernetMode	SbgEComEthernetMode

Enumerations
enum	_SbgEComEthernetMode { SBG_ECOM_ETHERNET_DHCP = 0, SBG_ECOM_ETHERNET_STATIC = 1 }

Functions
SbgErrorCode	sbgEComEthernetGetConf (SbgEComHandle *pHandle, SbgEComEthernetConf *pEthernetConf)
SbgErrorCode	sbgEComEthernetInfo (SbgEComHandle *pHandle, SbgEComEthernetConf *pEthernetConf)
SbgErrorCode	sbgEComEthernetSetConf (SbgEComHandle *pHandle, const SbgEComEthernetConf *pEthernetConf)

Detailed Description

This file implements SbgECom commands related to Ethernet configuration.

Author

SBG Systems (Maxime Renaudet)

Date

14 November 2016

Copyright Notice

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.

Definition in file sbgEComCmdEthernet.h.

Typedef Documentation

SbgEComEthernetConf

typedef struct _SbgEComEthernetConf SbgEComEthernetConf

Structure that contains all Ethernet configuration or settings.

SbgEComEthernetMode

typedef enum _SbgEComEthernetMode SbgEComEthernetMode

Enum that defines the different type of IP acquisition method.

Enumeration Type Documentation

_SbgEComEthernetMode

enum _SbgEComEthernetMode

Enum that defines the different type of IP acquisition method.

Enumerator
SBG_ECOM_ETHERNET_DHCP	The TCP/IP configuration should be acquired from a DHCP server.
SBG_ECOM_ETHERNET_STATIC	The TCP/IP configuration is manually defined.

Definition at line 32 of file sbgEComCmdEthernet.h.

Function Documentation

sbgEComEthernetGetConf()

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.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pEthernetConf	Poiner to a SbgEComEthernetConf struct that holds the read configuration from the device.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 74 of file sbgEComCmdEthernet.c.

sbgEComEthernetInfo()

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.

Parameters

[in]	pHandle	A valid sbgECom handle.
[out]	pEthernetConf	Poiner to a SbgEComEthernetConf struct that holds the read IP settings from the device.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 218 of file sbgEComCmdEthernet.c.

sbgEComEthernetSetConf()

SbgErrorCode sbgEComEthernetSetConf	(	SbgEComHandle *	pHandle,
		const SbgEComEthernetConf *	pEthernetConf
	)

Set the configuration for the Ethernet interface.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	pEthernetConf	Poiner to a SbgEComEthernetConf struct that holds the new configuration to apply.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 144 of file sbgEComCmdEthernet.c.