A convenient Client::Future and request id pair. More...
#include <rclcpp/client.hpp>
Inheritance diagram for rclcpp::Client< ServiceT >::FutureAndRequestId:
Collaboration diagram for rclcpp::Client< ServiceT >::FutureAndRequestId:
Public Member Functions | |
| operator SharedFuture () | |
Deprecated, use .future.share() instead. More... | |
| SharedFuture | share () noexcept |
| See std::future::share(). | |
 Public Member Functions inherited from rclcpp::detail::FutureAndRequestId< std::future< SharedResponse > > | |
| FutureAndRequestId (std::future< SharedResponse > impl, int64_t req_id) | |
| FutureAndRequestId (FutureAndRequestId &&other) noexcept=default | |
| Move constructor. | |
| FutureAndRequestId (const FutureAndRequestId &other)=delete | |
| Deleted copy constructor, each instance is a unique owner of the future. | |
| operator std::future< SharedResponse > & () | |
Allow implicit conversions to std::future by reference. | |
| operator std::future< SharedResponse > () | |
Deprecated, use the future member variable instead. More... | |
| auto | get () |
| See std::future::get(). | |
| bool | valid () const noexcept |
| See std::future::valid(). | |
| void | wait () const |
| See std::future::wait(). | |
| std::future_status | wait_for (const std::chrono::duration< Rep, Period > &timeout_duration) const |
| See std::future::wait_for(). | |
| std::future_status | wait_until (const std::chrono::time_point< Clock, Duration > &timeout_time) const |
| See std::future::wait_until(). | |
| FutureAndRequestId & | operator= (FutureAndRequestId &&other) noexcept=default |
| Move assignment. | |
| FutureAndRequestId & | operator= (const FutureAndRequestId &other)=delete |
| Deleted copy assignment, each instance is a unique owner of the future. | |
| ~FutureAndRequestId ()=default | |
| Destructor. | |
Additional Inherited Members | |
| Public Attributes inherited from rclcpp::detail::FutureAndRequestId< std::future< SharedResponse > > | |
| std::future< SharedResponse > | future |
| int64_t | request_id |
Detailed Description
template<typename ServiceT>
struct rclcpp::Client< ServiceT >::FutureAndRequestId
A convenient Client::Future and request id pair.
Public members:
- future: a std::future<SharedResponse>.
- request_id: the request id associated with the future.
All the other methods are equivalent to the ones std::future provides.
Definition at line 434 of file client.hpp.
Member Function Documentation
◆ operator SharedFuture()
template<typename ServiceT >
|
inline |
Deprecated, use .future.share() instead.
Allow implicit conversions to std::shared_future by value.
Definition at line 446 of file client.hpp.
References rclcpp::Client< ServiceT >::FutureAndRequestId::share().
Here is the call graph for this function:
The documentation for this struct was generated from the following file:
- rclcpp/include/rclcpp/client.hpp
