Acl::IControlDataReceiver::IRequest
Acl::IControlDataReceiver::IRequest Class Reference
Interface for a request that can be responded to.
#include <IControlDataReceiver.h>
Public Functions
| Name | |
|---|---|
| IRequest() =default Default constructor. | |
| virtual | ~IRequest() =default Default destructor. |
| virtual const RequestData & | getRequestData() =0 Get the incoming request. |
| virtual bool | respond(std::string && message) =0 Respond to a request, can only be called once per request. |
Public Functions Documentation
function IRequest
IRequest() =default
Default constructor.
function ~IRequest
virtual ~IRequest() =default
Default destructor.
function getRequestData
virtual const RequestData & getRequestData() =0
Get the incoming request.
Return: A reference to the incoming request object
function respond
virtual bool respond(
std::string && message
) =0
Respond to a request, can only be called once per request.
Parameters:
- message The response message for this request
Return: True if the response was accepted, false in case the request already has a response