Inheritance diagram for openlcb::MemoryConfigClientWithStream:

Classes
struct	DefaultSink
	Stores incoming stream data into the request()->payload object (which is a string). More...

Public Member Functions
	MemoryConfigClientWithStream (Node node, MemoryConfigHandler memcfg, uint8_t local_stream_id)

Public Member Functions inherited from openlcb::MemoryConfigClient
	MemoryConfigClient (Node node, MemoryConfigHandler memcfg)

Node *	node ()

MemoryConfigHandler *	mem_cfg ()

Public Member Functions inherited from CallableFlow< MemoryConfigClientRequest >
	CallableFlow (Service *s)
	Creates a callable flow.

Public Member Functions inherited from StateFlow< MessageType, QueueType >
	StateFlow (Service *service)
	Constructor.

Public Member Functions inherited from TypedStateFlow< MessageType, UntypedStateFlow< QueueType > >
	TypedStateFlow (Service *service)
	Constructor.

virtual	~TypedStateFlow ()
	Destructor.

void	send (MessageType *msg, unsigned priority=UINT_MAX) OVERRIDE
	Sends a message to the state flow for processing.

Public Member Functions inherited from UntypedStateFlow< QueueType >
	UntypedStateFlow (Service *service)
	Constructor.

Public Member Functions inherited from StateFlowWithQueue
void	notify () override
	Wakeup call arrived. Schedules *this on the executor.

bool	is_waiting ()

Public Member Functions inherited from StateFlowBase
void	run () override
	Callback from the executor.

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.

Public Member Functions inherited from LinkedObject< StateFlowWithQueue >
StateFlowWithQueue *	link_next ()

Public Member Functions inherited from FlowInterface< MessageType >
virtual Pool *	pool ()

virtual MessageType *	type_helper ()
	This function is never user in the code, but GDB can use it to infer the correct message types.

MessageType *	alloc ()
	Synchronously allocates a message buffer from the pool of this flow.

void	alloc_async (Executable *target)
	Asynchronously allocates a message buffer from the pool of this flow.

Protected Member Functions
Action	entry () override
	Entry into the StateFlow activity.

Action	do_stream_read ()

Action	send_stream_read_datagram ()

Action	stream_read_dg_complete ()

Action	stream_read_response_timeout ()

Action	wait_for_stream_complete ()

Action	recv_stream_closed ()

Action	handle_read_error (int error)
	Called upon various error conditions, typically before opening the stream.

Action	cleanup_after_error ()

Protected Member Functions inherited from openlcb::MemoryConfigClient
Action	handle_read_error (int error)

void	cleanup_read ()

Action	finish_read ()

DatagramService *	dg_service ()

Protected Member Functions inherited from CallableFlow< MemoryConfigClientRequest >
MemoryConfigClientRequest *	request ()

bool	has_request ()

Action	return_ok ()
	Terminates the flow and returns the request buffer to the caller with an error code of OK (zero).

Action	wait_and_return_ok ()
	Waits to be notified before moving onto the next state for termination.

Action	wait_done ()
	Terminates the flow and returns the request buffer to the caller with an error code of OK (zero).

Action	return_with_error (int error)
	Terminates the flow and returns the request buffer to the caller with an specific error code.

Protected Member Functions inherited from TypedStateFlow< MessageType, UntypedStateFlow< QueueType > >
void	release () OVERRIDE
	Unrefs the current buffer.

void	return_buffer ()
	For state flows that are operated using invoke_subflow_and_wait this is a way to hand back the buffer to the caller.

MessageType *	message ()

MessageType *	transfer_message ()
	Releases ownership of the current message.

Protected Member Functions inherited from UntypedStateFlow< QueueType >
void	send (BufferBase *msg, unsigned priority=UINT_MAX)
	Sends a message to the state flow for processing.

QMember *	queue_next (unsigned *priority) OVERRIDE
	Takes the front entry in the queue.

bool	queue_empty () OVERRIDE

Action	call_immediately (Callback c)
	Imediately call the next state upon return.

Protected Member Functions inherited from StateFlowWithQueue
	StateFlowWithQueue (Service *service)
	Constructor.

Action	exit ()
	Terminates the processing of this flow.

Action	release_and_exit ()
	Terminates the processing of the current message.

BufferBase *	message ()

BufferBase *	transfer_message ()
	Releases ownership of the current message.

void	reset_message (BufferBase *message, unsigned priority)
	Sets the current message being processed.

unsigned	priority ()

void	set_priority (unsigned priority)
	Overrides the current priority.

void	start_flow_at_init (Callback c)
	Call this from the constructor of the child class to do some work before the main queue processing loop begins.

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.

Protected Member Functions inherited from Atomic
void	lock ()

void	unlock ()

Protected Member Functions inherited from LinkedObject< StateFlowWithQueue >
StateFlowWithQueue *	link_this ()

	LinkedObject ()
	Constructor. Puts *this on the linked list.

	~LinkedObject ()
	Constructor. Removes *this from the linked list.

StateFlowWithQueue *	link_next ()

Protected Attributes
openlcb::MemoryConfigClientWithStream::DefaultSink	this

std::unique_ptr< StreamReceiverInterface >	receiver_

uint8_t	dstStreamId_
	stream ID on the local device.

BufferPtr< StreamReceiveRequest >	streamRecvRequest_
	Holds a ref to the stream receiver request.

Protected Attributes inherited from openlcb::MemoryConfigClient
Node *	node_
	Node from which to send the requests out.

MemoryConfigHandler *	memoryConfigHandler_
	Hook into the parent node's memory config handler service.

DatagramClient *	dgClient_ {nullptr}
	The allocated datagram client which we hold on for the time that we are querying.

ResponseFlow	responseFlow_ {this}
	Handler for the incoming reply datagrams.

BarrierNotifiable	bn_
	Notify helper.

std::unique_ptr< openlcb::NodeIdLookupFlow >	nodeIdlookupFlow_
	Rarely used helper flow to look up full node IDs from aliases.

uint32_t	offset_
	Next byte to read from the memory space.

uint32_t	payloadOffset_
	Next byte in the payload to write.

uint16_t	writeLength_
	How many bytes we wrote in this datagram.

StateFlowTimer	timer_ {this}
	timing helper

string	responsePayload_
	The data that came back from reading.

int	responseCode_
	error code that came with the response. 0 for success.

uint8_t	isWaitingForTimer_: 1
	1 if we are pending on the timer.

Protected Attributes inherited from QMember
QMember *	next
	pointer to the next member in the queue

Protected Attributes inherited from LinkedObject< StateFlowWithQueue >
StateFlowWithQueue *	link_
	Linked list pointer.

Additional Inherited Members
Public Types inherited from openlcb::MemoryConfigClient
enum	ResultCodes { OPERATION_PENDING , TIMEOUT }
	These result codes are written into request()->resultCode during and as a return from the flow. More...

Public Types inherited from TypedStateFlow< MessageType, UntypedStateFlow< QueueType > >
typedef Base::Action	Action
	Allows using Action without having StateFlowBase:: prefix in front of it.

Public Types inherited from FlowInterface< MessageType >
typedef MessageType	message_type
	Stores the message template type for external reference.

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.

Static Public Member Functions inherited from LinkedObject< StateFlowWithQueue >
static StateFlowWithQueue *	link_head ()

static Atomic *	head_mu ()
	Locks the list for modification (at any entry!).

Static Public Member Functions inherited from FlowInterface< MessageType >
static MessageType *	cast_alloc (QMember *entry)
	Down casts and initializes an asynchronous allocation result to the appropriate flow's buffer type.

Protected Types inherited from CallableFlow< MemoryConfigClientRequest >
using	Action = StateFlowBase::Action

Protected Types inherited from UntypedStateFlow< QueueType >
typedef Action(StateFlowBase::*	Callback) ()
	State Flow callback prototype.

Protected Types inherited from StateFlowBase
typedef Action(StateFlowBase::*	Callback) ()
	State Flow callback prototype.

Static Protected Member Functions inherited from LinkedObject< StateFlowWithQueue >
static StateFlowWithQueue *	link_head ()

static Atomic *	head_mu ()
	Locks the list for modification (at any entry!).

Static Protected Attributes inherited from LinkedObject< StateFlowWithQueue >
static StateFlowWithQueue *	head_
	Beginning of the list.

Detailed Description

Definition at line 828 of file MemoryConfigClient.hxx.

Constructor & Destructor Documentation

◆ MemoryConfigClientWithStream()

openlcb::MemoryConfigClientWithStream::MemoryConfigClientWithStream	(	Node *	node,
		MemoryConfigHandler *	memcfg,
		uint8_t	local_stream_id
	)

inline

Todo:: make this not specific to the CAN-buf interface but somehow portable.

Definition at line 831 of file MemoryConfigClient.hxx.

Member Function Documentation

◆ cleanup_after_error()

Action openlcb::MemoryConfigClientWithStream::cleanup_after_error ( )

inlineprotected

Definition at line 989 of file MemoryConfigClient.hxx.

◆ do_stream_read()

Action openlcb::MemoryConfigClientWithStream::do_stream_read ( )

inlineprotected

Todo:: add option to specify byte sink directly.

Definition at line 863 of file MemoryConfigClient.hxx.

◆ entry()

Action openlcb::MemoryConfigClientWithStream::entry ( )

inlineoverrideprotectedvirtual

Entry into the StateFlow activity.

Pure virtual which must be defined by derived class.

Returns: function pointer to next state

Reimplemented from openlcb::MemoryConfigClient.

Definition at line 845 of file MemoryConfigClient.hxx.

◆ handle_read_error()

Action openlcb::MemoryConfigClientWithStream::handle_read_error ( int error )

inlineprotected

Called upon various error conditions, typically before opening the stream.

Definition at line 980 of file MemoryConfigClient.hxx.

◆ recv_stream_closed()

Action openlcb::MemoryConfigClientWithStream::recv_stream_closed ( )

inlineprotected

Definition at line 973 of file MemoryConfigClient.hxx.

◆ send_stream_read_datagram()

Action openlcb::MemoryConfigClientWithStream::send_stream_read_datagram ( )

inlineprotected

Definition at line 882 of file MemoryConfigClient.hxx.

◆ stream_read_dg_complete()

Action openlcb::MemoryConfigClientWithStream::stream_read_dg_complete ( )

inlineprotected

Definition at line 896 of file MemoryConfigClient.hxx.

◆ stream_read_response_timeout()

Action openlcb::MemoryConfigClientWithStream::stream_read_response_timeout ( )

inlineprotected

Definition at line 915 of file MemoryConfigClient.hxx.

◆ wait_for_stream_complete()

Action openlcb::MemoryConfigClientWithStream::wait_for_stream_complete ( )

inlineprotected

Definition at line 961 of file MemoryConfigClient.hxx.

Member Data Documentation

◆ dstStreamId_

uint8_t openlcb::MemoryConfigClientWithStream::dstStreamId_

protected

stream ID on the local device.

Definition at line 1019 of file MemoryConfigClient.hxx.

◆ receiver_

std::unique_ptr<StreamReceiverInterface> openlcb::MemoryConfigClientWithStream::receiver_

protected

Definition at line 1017 of file MemoryConfigClient.hxx.

◆ streamRecvRequest_

BufferPtr<StreamReceiveRequest> openlcb::MemoryConfigClientWithStream::streamRecvRequest_

protected

Holds a ref to the stream receiver request.

Definition at line 1021 of file MemoryConfigClient.hxx.

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

MemoryConfigClient.hxx

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MemoryConfigClientWithStream()

Member Function Documentation

◆ cleanup_after_error()

◆ do_stream_read()

◆ entry()

◆ handle_read_error()

◆ recv_stream_closed()

◆ send_stream_read_datagram()

◆ stream_read_dg_complete()

◆ stream_read_response_timeout()

◆ wait_for_stream_complete()

Member Data Documentation

◆ dstStreamId_

◆ receiver_

◆ streamRecvRequest_