Conscience Core
Public Member Functions | List of all members
conscience_server::ConscienceServerCommandHandler Class Reference

#include <ConscienceServerCommandHandler.h>

Inheritance diagram for conscience_server::ConscienceServerCommandHandler:
conscience_core::communication::CscMessageHandler

Public Member Functions

 ConscienceServerCommandHandler (const EngineInfos *const engineInfos, CscMJPGStreamer *mjpgStreamer)
 
virtual optional< CscMessageHandlerResulthandleMessage (const string &messageSubject, const vector< string > &args, optional< int > knowledgeId, ptr< CscMessagingRequestContext > context) override
 
virtual optional< string > handleLowLevelMessage (const string &message) override
 
void setServerEntities (ServerEntities *serverEntities)
 
- Public Member Functions inherited from conscience_core::communication::CscMessageHandler
 CscMessageHandler ()
 
virtual ~CscMessageHandler ()
 

Constructor & Destructor Documentation

◆ ConscienceServerCommandHandler()

conscience_server::ConscienceServerCommandHandler::ConscienceServerCommandHandler ( const EngineInfos *const  engineInfos,
CscMJPGStreamer mjpgStreamer 
)

Member Function Documentation

◆ handleLowLevelMessage()

virtual optional<string> conscience_server::ConscienceServerCommandHandler::handleLowLevelMessage ( const string &  message)
overridevirtual

Handle a low level message. Low level means it is interpreted early in the message processing cycle. Typically it will be processed before encryption, placeholders interpolation or chunks reconstitution. It's useful to answer a simple, non sensitive, unencrypted message, for instance before communication is being secured.

Returns
a string if message has been handled (can be empty string). Return empty optional to declare message as not handled.

Implements conscience_core::communication::CscMessageHandler.

◆ handleMessage()

optional< CscMessageHandlerResult > conscience_server::ConscienceServerCommandHandler::handleMessage ( const string &  messageSubject,
const vector< string > &  args,
optional< int >  knowledgeId,
ptr< CscMessagingRequestContext context 
)
overridevirtual

Implement this method to handle Conscience messages received by the CscMessagingManager.

Parameters
messageSubjectaction / verb for this message, it is typically something like: GET_SCENE_OBJECTS
argsmessage's arguments
knowledgeIdmessage can optionally take a knowledgeId argument, which is a contextual information
contextinformation about the context of the message, contains the originator, and allows to respond
Note
MessageHandler implementation can just delegate most of the messages to Conscience Command API (please see processKnowledgeItemCommand)
See also
CscMessagingManager::sendBack(const string &response, ptr<CscMessagingRequestContext>)

Implements conscience_core::communication::CscMessageHandler.

◆ setServerEntities()

void conscience_server::ConscienceServerCommandHandler::setServerEntities ( ServerEntities serverEntities)

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