|
| SDOFuture () |
|
| SDOFuture (boost::unique_future< R > other, SDOClientBase *client, uint64 requestID) |
|
| SDOFuture (SDOFuture &&other) |
| move constructor More...
|
|
SDOFuture & | operator= (SDOFuture &&other) |
| move assignment operator More...
|
|
| operator ReturnValue () |
| Casts the return value of the SDO up/download associated to this future to R&&. More...
|
|
ReturnValue | get () |
| Obtains the return value of the SDO up/download associated to this future as rvalue R&&. More...
|
|
bool | isReady () const |
| Checks to see if the result of the RPC call associated with this future is set. More...
|
|
bool | hasException () const |
| Returns true if the RPC call associated with this future has finished with an exception rather than a return value. More...
|
|
bool | hasValue () const |
| Returns true if the RPC call associated with this future has finished with a return value value rather than an exception. More...
|
|
void | wait () const |
| Waits and blocks the current thread until the result of the associated RPC call is ready. More...
|
|
template<typename Duration > |
bool | timedWait (Duration const &relTime) const |
| Waits and blocks the current thread until the result of the associated RPC call is ready, or the time duration specified by waitDuration has elapsed. More...
|
|
bool | timedWaitUntil (boost::system_time const &absTime) const |
| Waits and blocks the current thread until the result of the associated RPC call is ready, or the time point specified by waitDuration has passed. More...
|
|
void | swap (SDOFutureCommon< R > &other) |
| Swaps ownership of the asynchronous results associated with other and *this. More...
|
|
template<typename R>
class mira::can::SDOFuture< R >
A SDOFuture is a proxy for the result of an asynchronous SDO upload or download.
It can be used to block the calling thread until the SDO up/download has finished and the result is available. The use of futures dramatically reduces latency in SDO calls, since the caller can decide whether it wants to wait for the result or not and where it wants to wait for the result.
The SDOFuture cannot be shared, however, the ownership can be transferred between different instances using the move constructor or move-assignment operator, but at most one instance holds a reference to a given asynchronous result. When the result is ready, it can be returned using get() by rvalue-reference to allow the result to be moved or copied as appropriate for the type.