#include "sbgEComCmdEthernet.h"
#include <streamBuffer/sbgStreamBuffer.h>

Include dependency graph for sbgEComCmdEthernet.c:

Functions
static SbgErrorCode	sbgEComEthernetConfParse (SbgStreamBuffer pInputStream, SbgEComEthernetConf pEthernetConf)

static SbgErrorCode	sbgEComEthernetConfWrite (SbgStreamBuffer pOutputStream, const SbgEComEthernetConf pEthernetConf)

SbgErrorCode	sbgEComEthernetGetConf (SbgEComHandle pHandle, SbgEComEthernetConf pEthernetConf)

SbgErrorCode	sbgEComEthernetInfo (SbgEComHandle pHandle, SbgEComEthernetConf pEthernetConf)

SbgErrorCode	sbgEComEthernetSetConf (SbgEComHandle pHandle, const SbgEComEthernetConf pEthernetConf)

Function Documentation

◆ sbgEComEthernetConfParse()

static SbgErrorCode sbgEComEthernetConfParse	(	SbgStreamBuffer *	pInputStream,
		SbgEComEthernetConf *	pEthernetConf
	)

static

Parse the input stream buffer to extract all parameters and fill the corresponding structure.

Parameters

[in]	pInputStream	Pointer on the input stream buffer to read from.
[out]	pEthernetConf	Structure used to store the parsed parameters.

Returns: SBG_NO_ERROR if the structure has been parsed correctly.

Definition at line 41 of file sbgEComCmdEthernet.c.

◆ sbgEComEthernetConfWrite()

static SbgErrorCode sbgEComEthernetConfWrite	(	SbgStreamBuffer *	pOutputStream,
		const SbgEComEthernetConf *	pEthernetConf
	)

static

Write in the output stream buffer, the provided Ethernet configuration.

Parameters

[out]	pOutputStream	Pointer on the output stream buffer to write to.
[in]	pEthernetConf	Structure used to hold the parameters to write to the payload buffer.

Returns: SBG_NO_ERROR if the structure has been written correctly.

Definition at line 14 of file sbgEComCmdEthernet.c.

◆ 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.

Functions

Function Documentation

◆ sbgEComEthernetConfParse()

◆ sbgEComEthernetConfWrite()

◆ sbgEComEthernetGetConf()

◆ sbgEComEthernetInfo()

◆ sbgEComEthernetSetConf()