Provides a handle-based interface to service client connections.
More...
#include <service_client.h>
|
template<class MReq , class MRes > |
bool | call (MReq &req, MRes &res) |
| Call the service aliased by this handle with the specified request/response messages. More...
|
|
template<class Service > |
bool | call (Service &service) |
| Call the service aliased by this handle with the specified service request/response. More...
|
|
template<typename MReq , typename MRes > |
bool | call (const MReq &req, MRes &resp, const std::string &service_md5sum) |
| Mostly for internal use, the other templated versions of call() just call into this one. More...
|
|
bool | call (const SerializedMessage &req, SerializedMessage &resp, const std::string &service_md5sum) |
|
bool | exists () |
| Checks if this is both advertised and available. More...
|
|
std::string | getService () |
| Returns the name of the service this ServiceClient connects to. More...
|
|
bool | isPersistent () const |
| Returns true if this handle points to a persistent service, false otherwise. More...
|
|
bool | isValid () const |
| Returns whether or not this handle is valid. For a persistent service, this becomes false when the connection has dropped. Non-persistent service handles are always valid. More...
|
|
| operator void * () const |
|
bool | operator!= (const ServiceClient &rhs) const |
|
bool | operator< (const ServiceClient &rhs) const |
|
bool | operator== (const ServiceClient &rhs) const |
|
| ServiceClient () |
|
| ServiceClient (const std::string &service_name, bool persistent, const M_string &header_values, const std::string &service_md5sum) |
|
| ServiceClient (const ServiceClient &rhs) |
|
void | shutdown () |
| Shutdown the connection associated with this ServiceClient. More...
|
|
bool | waitForExistence (ros::Duration timeout=ros::Duration(-1)) |
| Wait for this service to be advertised and available. Blocks until it is. More...
|
|
| ~ServiceClient () |
|
Provides a handle-based interface to service client connections.
Definition at line 42 of file service_client.h.
ros::ServiceClient::ServiceClient |
( |
| ) |
|
|
inline |
ros::ServiceClient::ServiceClient |
( |
const std::string & |
service_name, |
|
|
bool |
persistent, |
|
|
const M_string & |
header_values, |
|
|
const std::string & |
service_md5sum |
|
) |
| |
ros::ServiceClient::~ServiceClient |
( |
| ) |
|
template<class MReq , class MRes >
bool ros::ServiceClient::call |
( |
MReq & |
req, |
|
|
MRes & |
res |
|
) |
| |
|
inline |
template<class Service >
bool ros::ServiceClient::call |
( |
Service & |
service | ) |
|
|
inline |
Call the service aliased by this handle with the specified service request/response.
Definition at line 81 of file service_client.h.
template<typename MReq , typename MRes >
bool ros::ServiceClient::call |
( |
const MReq & |
req, |
|
|
MRes & |
resp, |
|
|
const std::string & |
service_md5sum |
|
) |
| |
|
inline |
Mostly for internal use, the other templated versions of call() just call into this one.
Definition at line 97 of file service_client.h.
void ros::ServiceClient::deserializeFailed |
( |
const std::exception & |
e | ) |
|
|
inlineprivate |
bool ros::ServiceClient::exists |
( |
| ) |
|
Checks if this is both advertised and available.
- Returns
- true if the service is up and available, false otherwise
Definition at line 193 of file service_client.cpp.
std::string ros::ServiceClient::getService |
( |
| ) |
|
bool ros::ServiceClient::isPersistent |
( |
| ) |
const |
Returns true if this handle points to a persistent service, false otherwise.
Definition at line 165 of file service_client.cpp.
bool ros::ServiceClient::isValid |
( |
| ) |
const |
Returns whether or not this handle is valid. For a persistent service, this becomes false when the connection has dropped. Non-persistent service handles are always valid.
Definition at line 155 of file service_client.cpp.
ros::ServiceClient::operator void * |
( |
| ) |
const |
|
inline |
bool ros::ServiceClient::operator!= |
( |
const ServiceClient & |
rhs | ) |
const |
|
inline |
bool ros::ServiceClient::operator< |
( |
const ServiceClient & |
rhs | ) |
const |
|
inline |
bool ros::ServiceClient::operator== |
( |
const ServiceClient & |
rhs | ) |
const |
|
inline |
void ros::ServiceClient::shutdown |
( |
| ) |
|
Shutdown the connection associated with this ServiceClient.
This method usually does not need to be explicitly called, as automatic shutdown happens when all copies of this ServiceClient go out of scope
This method overrides the automatic reference counted shutdown, and does so immediately.
Definition at line 175 of file service_client.cpp.
Wait for this service to be advertised and available. Blocks until it is.
- Parameters
-
timeout | The amount of time to wait for before timing out. If timeout is -1 (default), waits until the node is shutdown |
- Returns
- true on success, false otherwise
Definition at line 183 of file service_client.cpp.
The documentation for this class was generated from the following files:
roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim, Dirk Thomas
autogenerated on Mon Nov 2 2020 03:52:27