 |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
|
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
#include <Svc/FileDispatcher/FileDispatcher.hpp>
Public Member Functions | |
| FileDispatcher (const char *const compName) | |
| Construct FileDispatcher object. More... | |
| ~FileDispatcher () | |
| Destroy FileDispatcher object. More... | |
| void | configure (const FileDispatcherTable &table) |
| configure the component More... | |
 Public Member Functions inherited from Svc::FileDispatcherComponentBase | |
| void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
| Initialize FileDispatcherComponentBase object. More... | |
| Fw::InputCmdPort * | get_cmdIn_InputPort (FwIndexType portNum) |
| Svc::InputFileAnnouncePort * | get_fileAnnounceRecv_InputPort (FwIndexType portNum) |
| Svc::InputPingPort * | get_pingIn_InputPort (FwIndexType portNum) |
| void | set_cmdRegOut_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port) |
| Connect port to cmdRegOut[portNum]. More... | |
| void | set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port) |
| Connect port to cmdResponseOut[portNum]. More... | |
| void | set_logOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port) |
| Connect port to logOut[portNum]. More... | |
| void | set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port) |
| Connect port to timeCaller[portNum]. More... | |
| void | set_fileDispatch_OutputPort (FwIndexType portNum, Svc::InputFileDispatchPort *port) |
| Connect port to fileDispatch[portNum]. More... | |
| void | set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port) |
| Connect port to pingOut[portNum]. More... | |
| void | regCommands () |
| Register commands with the Command Dispatcher. More... | |
| Public Member Functions inherited from Fw::ActiveComponentBase | |
| void | start (FwTaskPriorityType priority=Os::Task::TASK_PRIORITY_DEFAULT, FwSizeType stackSize=Os::Task::TASK_DEFAULT, FwSizeType cpuAffinity=Os::Task::TASK_DEFAULT, FwTaskIdType identifier=static_cast< FwTaskIdType >(Os::Task::TASK_DEFAULT)) |
| called by instantiator when task is to be started More... | |
| void | exit () |
| exit task in active component More... | |
| Os::Task::Status | join () |
| Join the thread. More... | |
| DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()") | |
| Join to thread with discarded value_ptr. More... | |
| Public Member Functions inherited from Fw::QueuedComponentBase | |
| void | deinit () override |
| Allows de-initialization on teardown. More... | |
| Public Member Functions inherited from Fw::PassiveComponentBase | |
| void | setIdBase (const FwIdType) |
| Set the ID base. More... | |
| FwIdType | getIdBase () const |
Additional Inherited Members | |
| Public Types inherited from Fw::ActiveComponentBase | |
| enum | { ACTIVE_COMPONENT_EXIT } |
| Public Types inherited from Fw::QueuedComponentBase | |
| enum | MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT } |
| Protected Types inherited from Svc::FileDispatcherComponentBase | |
| enum | { NUM_CMDIN_INPUT_PORTS = 1 } |
| Enumerations for numbers of special input ports. More... | |
| enum | { NUM_FILEANNOUNCERECV_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1 } |
| Enumerations for numbers of typed input ports. More... | |
| enum | { NUM_CMDREGOUT_OUTPUT_PORTS = 1, NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1, NUM_LOGOUT_OUTPUT_PORTS = 1, NUM_LOGTEXTOUT_OUTPUT_PORTS = 1, NUM_TIMECALLER_OUTPUT_PORTS = 1 } |
| Enumerations for numbers of special output ports. More... | |
| enum | { NUM_FILEDISPATCH_OUTPUT_PORTS = 3, NUM_PINGOUT_OUTPUT_PORTS = 1 } |
| Enumerations for numbers of typed output ports. More... | |
| enum | { OPCODE_ENABLE_DISPATCH = 0x0 } |
| Command opcodes. More... | |
| enum | { EVENTID_FILEDISPATCHSTATE = 0x0, EVENTID_FILEDISPATCHED = 0x1 } |
| Event IDs. More... | |
| Protected Types inherited from Fw::ActiveComponentBase | |
| enum | Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE } |
| Tracks the lifecycle of the component. More... | |
| Protected Member Functions inherited from Svc::FileDispatcherComponentBase | |
| FileDispatcherComponentBase (const char *compName="") | |
| Construct FileDispatcherComponentBase object. More... | |
| virtual | ~FileDispatcherComponentBase () |
| Destroy FileDispatcherComponentBase object. More... | |
| bool | isConnected_cmdRegOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_logOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_timeCaller_OutputPort (FwIndexType portNum) |
| bool | isConnected_fileDispatch_OutputPort (FwIndexType portNum) |
| bool | isConnected_pingOut_OutputPort (FwIndexType portNum) |
| void | fileAnnounceRecv_handlerBase (FwIndexType portNum, Fw::StringBase &file_name) |
| Handler base-class function for input port fileAnnounceRecv. More... | |
| void | pingIn_handlerBase (FwIndexType portNum, U32 key) |
| Handler base-class function for input port pingIn. More... | |
| virtual void | fileAnnounceRecv_preMsgHook (FwIndexType portNum, Fw::StringBase &file_name) |
| Pre-message hook for async input port fileAnnounceRecv. More... | |
| virtual void | pingIn_preMsgHook (FwIndexType portNum, U32 key) |
| Pre-message hook for async input port pingIn. More... | |
| void | fileDispatch_out (FwIndexType portNum, Fw::StringBase &file_name) |
| Invoke output port fileDispatch. More... | |
| void | pingOut_out (FwIndexType portNum, U32 key) |
| Invoke output port pingOut. More... | |
| void | cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response) |
| Emit command response. More... | |
| void | ENABLE_DISPATCH_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| Base-class handler function for command ENABLE_DISPATCH. More... | |
| virtual void | ENABLE_DISPATCH_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command ENABLE_DISPATCH. More... | |
| void | log_ACTIVITY_HI_FileDispatchState (Svc::FileDispatcherCfg::FileDispatchPort file_type, Fw::Enabled enabled) const |
| Log event FileDispatchState. More... | |
| void | log_ACTIVITY_HI_FileDispatched (const Fw::StringBase &file_name, Svc::FileDispatcherCfg::FileDispatchPort file_type) const |
| Log event FileDispatched. More... | |
| Fw::Time | getTime () const |
| Protected Member Functions inherited from Fw::ActiveComponentBase | |
| ActiveComponentBase (const char *name) | |
| Constructor. More... | |
| virtual | ~ActiveComponentBase () |
| Destructor. More... | |
| void | init (FwEnumStoreType instance) |
| initialization code More... | |
| virtual void | preamble () |
| A function that will be called before the event loop is entered. More... | |
| MsgDispatchStatus | dispatch () |
| The function that will dispatching messages. More... | |
| virtual void | finalizer () |
| A function that will be called after exiting the loop. More... | |
| Protected Member Functions inherited from Fw::QueuedComponentBase | |
| QueuedComponentBase (const char *name) | |
| Constructor. More... | |
| virtual | ~QueuedComponentBase () |
| Destructor. More... | |
| void | init (FwEnumStoreType instance) |
| initialization function More... | |
| Os::Queue::Status | createQueue (FwSizeType depth, FwSizeType msgSize) |
| MsgDispatchStatus | dispatchAvailableMessages () |
| dispatches all messages currently in the queue, returning status of the dispatch More... | |
| FwSizeType | getNumMsgsDropped () |
| return number of messages dropped More... | |
| void | incNumMsgDropped () |
| increment the number of messages dropped More... | |
| Protected Member Functions inherited from Fw::PassiveComponentBase | |
| PassiveComponentBase (const char *name) | |
| Named constructor. More... | |
| virtual | ~PassiveComponentBase () |
| Destructor. More... | |
| void | init (FwEnumStoreType instance) |
| Initialization function. More... | |
| FwEnumStoreType | getInstance () const |
| Protected Member Functions inherited from Fw::ObjBase | |
| ObjBase (const char *name) | |
| ObjBase constructor. More... | |
| virtual | ~ObjBase () |
| Destructor. More... | |
| void | init () |
| Object initializer. More... | |
| Static Protected Member Functions inherited from Svc::FileDispatcherComponentBase | |
| static constexpr FwIndexType | getNum_cmdIn_InputPorts () |
| static constexpr FwIndexType | getNum_fileAnnounceRecv_InputPorts () |
| static constexpr FwIndexType | getNum_pingIn_InputPorts () |
| static constexpr FwIndexType | getNum_cmdRegOut_OutputPorts () |
| static constexpr FwIndexType | getNum_cmdResponseOut_OutputPorts () |
| static constexpr FwIndexType | getNum_logOut_OutputPorts () |
| static constexpr FwIndexType | getNum_timeCaller_OutputPorts () |
| static constexpr FwIndexType | getNum_fileDispatch_OutputPorts () |
| static constexpr FwIndexType | getNum_pingOut_OutputPorts () |
| Protected Attributes inherited from Fw::ActiveComponentBase | |
| Os::Task | m_task |
| task object for active component More... | |
| Protected Attributes inherited from Fw::QueuedComponentBase | |
| Os::Queue | m_queue |
| queue object for active component More... | |
Definition at line 25 of file FileDispatcher.hpp.
| Svc::FileDispatcher::FileDispatcher | ( | const char *const | compName | ) |
Construct FileDispatcher object.
| compName | The component name |
Definition at line 16 of file FileDispatcher.cpp.
| Svc::FileDispatcher::~FileDispatcher | ( | ) |
Destroy FileDispatcher object.
Definition at line 24 of file FileDispatcher.cpp.
| void Svc::FileDispatcher::configure | ( | const FileDispatcherTable & | table | ) |
configure the component
Definition at line 26 of file FileDispatcher.cpp.
1.8.14