dcc::DccDecodeFlow Class Reference

User-space DCC decoding flow. More...

#include <Receiver.hxx>

Inheritance diagram for dcc::DccDecodeFlow:

Public Member Functions
	DccDecodeFlow (Service *s, const char *dev)
Public Member Functions inherited from StateFlowBase
void	run () override
	Callback from the executor.
void	notify () override
	Wakeup call arrived.
Service *	service ()
	Return a pointer to the service I am bound to.
Public Member Functions inherited from Executable
void	test_deletion ()
Public Member Functions inherited from QMember
void	init ()
	Initiailize a QMember, in place of a public placement construction.

Protected Attributes
DCCPacket	pkt_
	Packet buffer.
DccDecoder	decoder_ {1}
	State machine that does the DCC decoding.
Protected Attributes inherited from QMember
QMember *	next
	pointer to the next member in the queue

Private Member Functions
Action	register_and_sleep ()
Action	data_arrived ()
virtual void	dcc_packet_finished (const uint8_t *payload, size_t len)=0
virtual void	mm_packet_finished (const uint8_t *payload, size_t len)=0
virtual void	debug_data (uint32_t value)

Private Attributes
int	fd_
uint32_t	lastValue_ = 0

Additional Inherited Members
Static Public Member Functions inherited from StateFlowBase
template<class T , typename... Args>
static void	invoke_subflow_and_ignore_result (FlowInterface< Buffer< T > > *target_flow, Args &&... args)
	Calls a helper flow to perform some actions.
Protected Types inherited from StateFlowBase
typedef Action(StateFlowBase::*	Callback) ()
	State Flow callback prototype.
Protected Member Functions inherited from StateFlowBase
	StateFlowBase (Service *service)
	Constructor.
	~StateFlowBase ()
	Destructor.
void	reset_flow (Callback c)
	Resets the flow to the specified state.
bool	is_state (Callback c)
bool	is_terminated ()
void	start_flow (Callback c)
	Resets the flow to the specified state and starts it.
Action	again ()
	Call the current state again via call_immediately.
Action	exit ()
	Terminate current StateFlow activity.
Action	delete_this ()
	Terminates the flow and deletes *this.
Action	set_terminated ()
	Sets the flow to terminated state.
Action	call_immediately (Callback c)
	Imediately call the next state upon return.
Action	wait ()
	Wait for an asynchronous call.
Action	wait_and_call (Callback c)
	Wait for resource to become available before proceeding to next state.
template<class T >
Action	allocate_and_call (FlowInterface< Buffer< T > > *target_flow, Callback c, Pool *pool=nullptr)
	Allocates a buffer from a pool and proceed to the next state when allocation is successful.
Action	allocate_and_call (Callback c, QAsync *queue)
	Allocates an entry from an asynchronous queue, and transitions to a state once the allocation is complete.
template<class T >
Buffer< T > *	full_allocation_result (FlowInterface< Buffer< T > > *target_flow)
	Takes the result of the asynchronous allocation without resetting the object.
template<class T >
T *	full_allocation_result (TypedQAsync< T > *queue)
	Takes the result of the asynchronous allocation without resetting the object.
template<class T >
void	cast_allocation_result (T **member)
	Takes the result of the asynchronous allocation without resetting the object.
template<class T >
Buffer< T > *	get_allocation_result (FlowInterface< Buffer< T > > *target_flow)
	Takes the result of the asynchronous allocation.
Action	yield_and_call (Callback c)
	Place the current flow to the back of the executor, and transition to a new state after we get the CPU again.
Action	yield ()
	Place the current flow to the back of the executor, and re-try the current state after we get the CPU again.
Action	sleep_and_call (::Timer *timer, long long timeout_nsec, Callback c)
	Suspends execution of this control flow for a specified time.
template<class T , typename... Args>
Action	invoke_subflow_and_wait (FlowInterface< Buffer< T > > *target_flow, Callback c, Args &&... args)
	Calls a helper flow to perform some actions.
Action	read_repeated (StateFlowSelectHelper *helper, int fd, void *buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Blocks until size bytes are read and then invokes the next state.
Action	read_single (StateFlowSelectHelper *helper, int fd, void *buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Attempts to read at most size_t bytes, and blocks the caller until at least one byte is read.
Action	read_nonblocking (StateFlowSelectHelper *helper, int fd, void *buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Attempts to read at most size bytes, and then invokes the next state, even if only zero bytes are available right now.
Action	read_repeated_with_timeout (StateFlowTimedSelectHelper *helper, long long timeout_nsec, int fd, void *buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Blocks until size bytes are read, or a timeout expires.
Action	internal_try_read ()
	Implementation state that gets repeatedly called upon every wakeup and tries to make progress on reading.
Action	write_repeated (StateFlowSelectHelper *helper, int fd, const void *buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Writes some data into a file descriptor, repeating the operation as necessary until all bytes are written.
Action	internal_try_write ()
	Implementation state that gets repeatedly called upon every wakeup and tries to make progress on writing.
Protected Member Functions inherited from QMember
	QMember ()
	Constructor.
	~QMember ()
	Destructor.

Detailed Description

User-space DCC decoding flow.

This flow receives a sequence of numbers from the DCC driver, where each number means a specific number of microseconds for which the signal was of the same polarity (e.g. for dcc packet it would be something like 56, 56, 56, 56, ..., 56, 56, 105, 105, 56, 56, ...). Then calls for each packet the virtual function dcc_packet_finished() or mm_packet_finished().

This flow is a pretty expensive way to decode DCC data.

Definition at line 456 of file Receiver.hxx.

Constructor & Destructor Documentation

DccDecodeFlow()

dcc::DccDecodeFlow::DccDecodeFlow ( Service *  s, const char *  dev  )

inline

Definition at line 459 of file Receiver.hxx.

Member Function Documentation

data_arrived()

Action dcc::DccDecodeFlow::data_arrived ( )

inlineprivate

Definition at line 474 of file Receiver.hxx.

debug_data()

virtual void dcc::DccDecodeFlow::debug_data ( uint32_t  value )

inlineprivatevirtual

Definition at line 503 of file Receiver.hxx.

register_and_sleep()

Action dcc::DccDecodeFlow::register_and_sleep ( )

inlineprivate

Definition at line 468 of file Receiver.hxx.

Member Data Documentation

decoder_

DccDecoder dcc::DccDecodeFlow::decoder_ {1}

protected

State machine that does the DCC decoding.

We have 1 usec per tick, as these are the numbers we receive from the driver.

Definition at line 515 of file Receiver.hxx.

fd_

int dcc::DccDecodeFlow::fd_

private

Definition at line 507 of file Receiver.hxx.

lastValue_

uint32_t dcc::DccDecodeFlow::lastValue_ = 0

private

Definition at line 508 of file Receiver.hxx.

pkt_

DCCPacket dcc::DccDecodeFlow::pkt_

protected

Packet buffer.

Definition at line 512 of file Receiver.hxx.

---

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

• Receiver.hxx