ReqHandler.hh
Go to the documentation of this file.
Interface class used to manage a request handler.
Definition ReqHandler.hh:45
IReqHandler(const std::string &_nUuid)
Constructor.
Definition ReqHandler.hh:48
bool Result() const
Get the result of the service response.
Definition ReqHandler.hh:86
void Requested(const bool _value)
Mark the service call as requested (or not).
Definition ReqHandler.hh:100
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:167
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:152
bool Requested() const
Returns if this service call request has already been requested.
Definition ReqHandler.hh:93
std::string Response() const
Get the service response as raw bytes.
Definition ReqHandler.hh:79
std::string HandlerUuid() const
Returns the unique handler UUID.
Definition ReqHandler.hh:112
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:124
virtual bool Serialize(std::string &_buffer) const =0
Serialize the Req protobuf message stored.
std::string hUuid
Unique handler's UUID.
Definition ReqHandler.hh:155
std::string rep
Stores the service response as raw bytes.
Definition ReqHandler.hh:149
std::condition_variable_any condition
Condition variable used to wait until a service call REP is available.
Definition ReqHandler.hh:146
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:72
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:325
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:357
bool Serialize(std::string &_buffer) const
Serialize the Req protobuf message stored.
Definition ReqHandler.hh:338
ReqHandler(const std::string &_nUuid)
Definition ReqHandler.hh:301
void SetMessage(const google::protobuf::Message *_reqMsg)
Set the REQ protobuf message for this handler.
Definition ReqHandler.hh:309
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:380
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:367
It creates a reply handler for the specific protobuf messages used. 'Req' is a protobuf message type ...
Definition ReqHandler.hh:177
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:250
std::shared_ptr< Rep > CreateMsg(const std::string &_data) const
Create a specific protobuf message given its serialized data.
Definition ReqHandler.hh:187
bool Serialize(std::string &_buffer) const
Serialize the Req protobuf message stored.
Definition ReqHandler.hh:237
void SetMessage(const Req *_reqMsg)
Set the REQ protobuf message for this handler.
Definition ReqHandler.hh:216
ReqHandler(const std::string &_nUuid)
Definition ReqHandler.hh:179
virtual std::string RepTypeName() const
Get the message type name used in the service response.
Definition ReqHandler.hh:277
void SetCallback(const std::function< void(const Rep &_rep, const bool _result)> &_cb)
Set the callback for this handler.
Definition ReqHandler.hh:207
virtual std::string ReqTypeName() const
Get the message type name used in the service request.
Definition ReqHandler.hh:271
void SetResponse(const Rep *)
This function is only used for compatibility with SetResponse() when [REP = google::protobuf::Message...
Definition ReqHandler.hh:232
A portable class for representing a Universally Unique Identifier.
Definition Uuid.hh:42
T endl(T... args)
*brief Advertise a new service without any output parameter *In this version the callback is a free function *param[in] _topic Topic name associated to the service *param[in] _cb Callback to handle the service request with the *following void(* _cb)(const RequestT &_req)
Definition Node.hh:527
Definition AdvertiseOptions.hh:28
T notify_one(T... args)
T now(T... args)
T wait_until(T... args)