c_InputDDP Class Reference

#include <InputDDP.h>

Inheritance diagram for c_InputDDP:

Collaboration diagram for c_InputDDP:

Classes
struct	PacketBuffer_t

Public Member Functions
	c_InputDDP (c_InputMgr::e_InputChannelIds NewInputChannelId, c_InputMgr::e_InputType NewChannelType, uint32_t BufferSize)
virtual	~c_InputDDP ()
void	Begin ()
	set up the operating environment based on the current config (or defaults)
bool	SetConfig (JsonObject &jsonConfig)
	Set a new config in the driver.
void	GetConfig (JsonObject &jsonConfig)
	Get the current config used by the driver.
void	GetStatus (JsonObject &jsonStatus)
void	Process ()
	Call from loop(), renders Input data.
void	GetDriverName (String &sDriverName)
	get the name for the instantiated driver
void	SetBufferInfo (uint32_t BufferSize)
bool	isShutDownRebootNeeded ()
Public Member Functions inherited from c_InputCommon
	c_InputCommon (c_InputMgr::e_InputChannelIds NewInputChannelId, c_InputMgr::e_InputType NewChannelType, uint32_t BufferSize)
	< Start up the driver and put it into a safe mode
virtual	~c_InputCommon ()
virtual bool	SetConfig (ArduinoJson::JsonObject &jsonConfig)=0
	Set a new config in the driver.
virtual void	GetConfig (ArduinoJson::JsonObject &jsonConfig)=0
	Get the current config used by the driver.
virtual void	SetOperationalState (bool ActiveFlag)
virtual void	ProcessButtonActions (c_ExternalInput::InputValue_t value)
c_InputMgr::e_InputChannelIds	GetInputChannelId ()
c_InputMgr::e_InputType	GetInputType ()

Private Types
enum	PacketBufferStatus_t { BufferIsAvailable , BufferIsFilled , BufferIsBeingProcessed }

Private Member Functions
struct	__attribute__ ((packed)) DDP_Header_t
struct	__attribute__ ((packed)) DDP_packet_t
struct	__attribute__ ((packed)) DDP_TimeCode_packet_t
struct	__attribute__ ((packed)) DDP_stats_t
void	NetworkStateChanged (bool NetwokState)
void	ProcessReceivedUdpPacket (AsyncUDPPacket _packet)
void	ProcessReceivedData (DDP_packet_t &Packet)
void	ProcessReceivedQuery ()

Private Attributes
String	lastError
AsyncUDP *	udp = nullptr
uint8_t	lastReceivedSequenceNumber = 0
bool	suspend = false
DDP_stats_t	stats
PacketBuffer_t	PacketBuffer

Additional Inherited Members
Protected Attributes inherited from c_InputCommon
bool	HasBeenInitialized = false
uint32_t	InputDataBufferSize = 0
bool	IsInputChannelActive = true
c_InputMgr::e_InputChannelIds	InputChannelId = c_InputMgr::e_InputChannelIds::InputChannelId_ALL
c_InputMgr::e_InputType	ChannelType = c_InputMgr::e_InputType::InputType_Disabled

Member Enumeration Documentation

PacketBufferStatus_t

enum c_InputDDP::PacketBufferStatus_t

private

Enumerator
BufferIsAvailable
BufferIsFilled
BufferIsBeingProcessed

Constructor & Destructor Documentation

c_InputDDP()

c_InputDDP::c_InputDDP	(	c_InputMgr::e_InputChannelIds	NewInputChannelId,
		c_InputMgr::e_InputType	NewChannelType,
		uint32_t	BufferSize )

~c_InputDDP()

c_InputDDP::~c_InputDDP ( )

virtual

Member Function Documentation

__attribute__() [1/4]

struct c_InputDDP::__attribute__ ( (packed) )

inlineprivate

__attribute__() [2/4]

struct c_InputDDP::__attribute__ ( (packed) )

inlineprivate

__attribute__() [3/4]

struct c_InputDDP::__attribute__ ( (packed) )

inlineprivate

__attribute__() [4/4]

struct c_InputDDP::__attribute__ ( (packed) )

inlineprivate

Begin()

void c_InputDDP::Begin ( )

virtual

set up the operating environment based on the current config (or defaults)

Implements c_InputCommon.

Here is the call graph for this function:

GetConfig()

void c_InputDDP::GetConfig

(

JsonObject &

jsonConfig

)

Get the current config used by the driver.

GetDriverName()

void c_InputDDP::GetDriverName ( String & sDriverName )

inlinevirtual

get the name for the instantiated driver

Implements c_InputCommon.

GetStatus()

void c_InputDDP::GetStatus ( JsonObject & jsonStatus )

virtual

Implements c_InputCommon.

isShutDownRebootNeeded()

bool c_InputDDP::isShutDownRebootNeeded ( )

inlinevirtual

Reimplemented from c_InputCommon.

NetworkStateChanged()

void c_InputDDP::NetworkStateChanged ( bool NetwokState )

privatevirtual

Reimplemented from c_InputCommon.

Here is the call graph for this function:

Here is the caller graph for this function:

Process()

void c_InputDDP::Process ( void )

virtual

Call from loop(), renders Input data.

Implements c_InputCommon.

Here is the call graph for this function:

ProcessReceivedData()

void c_InputDDP::ProcessReceivedData ( DDP_packet_t & Packet )

private

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessReceivedQuery()

void c_InputDDP::ProcessReceivedQuery ( )

private

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessReceivedUdpPacket()

void c_InputDDP::ProcessReceivedUdpPacket ( AsyncUDPPacket _packet )

private

Here is the call graph for this function:

Here is the caller graph for this function:

SetBufferInfo()

void c_InputDDP::SetBufferInfo ( uint32_t BufferSize )

virtual

Implements c_InputCommon.

SetConfig()

bool c_InputDDP::SetConfig

(

JsonObject &

jsonConfig

)

Set a new config in the driver.

Member Data Documentation

lastError

String c_InputDDP::lastError

private

lastReceivedSequenceNumber

uint8_t c_InputDDP::lastReceivedSequenceNumber = 0

private

PacketBuffer

PacketBuffer_t c_InputDDP::PacketBuffer

private

stats

DDP_stats_t c_InputDDP::stats

private

suspend

bool c_InputDDP::suspend = false

private

udp

AsyncUDP* c_InputDDP::udp = nullptr

private

---

The documentation for this class was generated from the following files:

• /github/workspace/include/input/InputDDP.h
• /github/workspace/src/input/InputDDP.cpp