ReqHandler.hh
Go to the documentation of this file.
Interface class used to manage a request handler.
Definition: ReqHandler.hh:49
IReqHandler(const std::string &_nUuid)
Constructor.
Definition: ReqHandler.hh:52
bool Result() const
Get the result of the service response.
Definition: ReqHandler.hh:90
void Requested(const bool _value)
Mark the service call as requested (or not).
Definition: ReqHandler.hh:104
bool repAvailable
When there is a blocking service call request, the call can be unlocked when a service call REP is av...
Definition: ReqHandler.hh:180
virtual void NotifyResult(const std::string &_rep, const bool _result)=0
Executes the callback registered for this handler and notify a potential requester waiting on a block...
bool result
Stores the result of the service call.
Definition: ReqHandler.hh:171
bool Requested() const
Returns if this service call request has already been requested.
Definition: ReqHandler.hh:97
std::string Response() const
Get the service response as raw bytes.
Definition: ReqHandler.hh:83
std::string HandlerUuid() const
Returns the unique handler UUID.
Definition: ReqHandler.hh:116
bool WaitUntil(Lock &_lock, const unsigned int _timeout)
Block the current thread until the response to the service request is available or until the timeout ...
Definition: ReqHandler.hh:128
virtual bool Serialize(std::string &_buffer) const =0
Serialize the Req protobuf message stored.
std::string hUuid
Unique handler's UUID.
Definition: ReqHandler.hh:162
std::string rep
Stores the service response as raw bytes.
Definition: ReqHandler.hh:159
std::condition_variable_any condition
Condition variable used to wait until a service call REP is available.
Definition: ReqHandler.hh:156
virtual std::string RepTypeName() const =0
Get the message type name used in the service response.
std::string NodeUuid() const
Get the node UUID.
Definition: ReqHandler.hh:76
virtual std::string ReqTypeName() const =0
Get the message type name used in the service request.
ignition::transport::ReqHandler< google::protobuf::Message, google::protobuf::Message >::SetResponse
void SetResponse(const google::protobuf::Message *_repMsg)
Set the REP protobuf message for this handler.
Definition: ReqHandler.hh:338
void NotifyResult(const std::string &_rep, const bool _result)
Executes the callback registered for this handler and notify a potential requester waiting on a block...
Definition: ReqHandler.hh:370
bool Serialize(std::string &_buffer) const
Serialize the Req protobuf message stored.
Definition: ReqHandler.hh:351
ReqHandler(const std::string &_nUuid)
Definition: ReqHandler.hh:314
void SetMessage(const google::protobuf::Message *_reqMsg)
Set the REQ protobuf message for this handler.
Definition: ReqHandler.hh:322
ignition::transport::ReqHandler< google::protobuf::Message, google::protobuf::Message >::RepTypeName
virtual std::string RepTypeName() const
Get the message type name used in the service response.
Definition: ReqHandler.hh:393
ignition::transport::ReqHandler< google::protobuf::Message, google::protobuf::Message >::ReqTypeName
virtual std::string ReqTypeName() const
Get the message type name used in the service request.
Definition: ReqHandler.hh:380
It creates a reply handler for the specific protobuf messages used. 'Req' is a protobuf message type ...
Definition: ReqHandler.hh:190
void NotifyResult(const std::string &_rep, const bool _result)
Executes the callback registered for this handler and notify a potential requester waiting on a block...
Definition: ReqHandler.hh:263
std::shared_ptr< Rep > CreateMsg(const std::string &_data) const
Create a specific protobuf message given its serialized data.
Definition: ReqHandler.hh:200
bool Serialize(std::string &_buffer) const
Serialize the Req protobuf message stored.
Definition: ReqHandler.hh:250
void SetMessage(const Req *_reqMsg)
Set the REQ protobuf message for this handler.
Definition: ReqHandler.hh:229
ReqHandler(const std::string &_nUuid)
Definition: ReqHandler.hh:192
virtual std::string RepTypeName() const
Get the message type name used in the service response.
Definition: ReqHandler.hh:290
void SetCallback(const std::function< void(const Rep &_rep, const bool _result)> &_cb)
Set the callback for this handler.
Definition: ReqHandler.hh:220
virtual std::string ReqTypeName() const
Get the message type name used in the service request.
Definition: ReqHandler.hh:284
void SetResponse(const Rep *)
This function is only used for compatibility with SetResponse() when [REP = google::protobuf::Message...
Definition: ReqHandler.hh:245
A portable class for representing a Universally Unique Identifier.
Definition: Uuid.hh:46
T endl(T... args)
Definition: AdvertiseOptions.hh:29
T now(T... args)