Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
withrottle::ServerCommandBase Class Reference

WiThrottle server command handler base object. More...

#include <ServerCommand.hxx>

Inheritance diagram for withrottle::ServerCommandBase:
StateFlow< Buffer< ThrottleCommand >, QList< 1 > > TypedStateFlow< MessageType, Base > FlowInterface< MessageType > withrottle::ServerCommandLoco

Protected Member Functions

 ServerCommandBase (ThrottleFlow *throttle, CommandType type)
 Constructor.
 
 ~ServerCommandBase ()
 Destructor.
 
- Protected Member Functions inherited from TypedStateFlow< MessageType, Base >
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 Attributes

ThrottleFlowthrottle
 pointer to parent throttle
 

Private Member Functions

 DISALLOW_COPY_AND_ASSIGN (ServerCommandBase)
 

Additional Inherited Members

- Public Types inherited from TypedStateFlow< MessageType, Base >
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.
 
- Public Member Functions inherited from StateFlow< Buffer< ThrottleCommand >, QList< 1 > >
 StateFlow (Service *service)
 Constructor.
 
- Public Member Functions inherited from TypedStateFlow< MessageType, Base >
 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.
 
virtual Action entry () override=0
 Entry into the StateFlow activity.
 
- Public Member Functions inherited from FlowInterface< MessageType >
virtual Poolpool ()
 
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.
 
- 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.
 

Detailed Description

WiThrottle server command handler base object.

Definition at line 43 of file ServerCommand.hxx.

Constructor & Destructor Documentation

◆ ServerCommandBase()

withrottle::ServerCommandBase::ServerCommandBase ( ThrottleFlow throttle,
CommandType  type 
)
protected

Constructor.

Parameters
throttleparent throttle that this flow is acting on
typethe command type belonging to this handler.

Definition at line 38 of file ServerCommand.cxx.

◆ ~ServerCommandBase()

withrottle::ServerCommandBase::~ServerCommandBase ( )
protected

Destructor.

Definition at line 48 of file ServerCommand.cxx.

Member Data Documentation

◆ throttle

ThrottleFlow* withrottle::ServerCommandBase::throttle
protected

pointer to parent throttle

Definition at line 57 of file ServerCommand.hxx.


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