SDOFuture< void > Class Template Reference

This is a specialization for SDO calls with the return type of void, where no get() method is available. More...

#include <can/SDOFuture.h>

Inheritance diagram for SDOFuture< void >:

Public Member Functions
	SDOFuture ()
	SDOFuture (boost::unique_future< void > other, SDOClientBase *client, uint64 requestID)
	SDOFuture (SDOFuture &&other)
	move constructor More...
SDOFuture &	operator= (SDOFuture &&other)
	move assignment operator More...
void	get ()
	Waits until the call has finished and will raise an exception if the call has failed. 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...
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< void > &other)
	Swaps ownership of the asynchronous results associated with other and *this. More...

Protected Attributes
SDOClientBase *	mClient
uint64	mRequestID
boost::unique_future< void >	mFuture

Detailed Description

template<>
class mira::can::SDOFuture< void >

This is a specialization for SDO calls with the return type of void, where no get() method is available.

See also

SDOFuture, SDOFuture<R>

Constructor & Destructor Documentation

SDOFuture() [1/3]

SDOFuture ( )

inline

SDOFuture() [2/3]

SDOFuture ( boost::unique_future< void >  other, SDOClientBase *  client, uint64  requestID  )

inline

SDOFuture() [3/3]

SDOFuture ( SDOFuture< void > &&  other )

inline

move constructor

Member Function Documentation

operator=()

SDOFuture& operator= ( SDOFuture< void > &&  other )

inline

move assignment operator

get()

void get ( )

inline

Waits until the call has finished and will raise an exception if the call has failed.

Note

This method will block until the call has finished.

This method will throw the exception that may have occurred on the server side while processing the call.

See also

wait(), timedWait(), hasValue(), hasException()

isReady()

bool isReady ( ) const

inlineinherited

Checks to see if the result of the RPC call associated with this future is set.

hasException()

bool hasException ( ) const

inlineinherited

Returns true if the RPC call associated with this future has finished with an exception rather than a return value.

hasValue()

bool hasValue ( ) const

inlineinherited

Returns true if the RPC call associated with this future has finished with a return value value rather than an exception.

wait()

void wait ( ) const

inlineinherited

Waits and blocks the current thread until the result of the associated RPC call is ready.

This is an interruption point.

timedWait()

bool timedWait ( Duration const &  relTime ) const

inlineinherited

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.

This is an interruption point.

timedWaitUntil()

bool timedWaitUntil ( boost::system_time const &  absTime ) const

inlineinherited

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.

This is an interruption point.

swap()

void swap ( SDOFutureCommon< void > &  other )

inlineinherited

Swaps ownership of the asynchronous results associated with other and *this.

Member Data Documentation

mClient

SDOClientBase* mClient

protectedinherited

mRequestID

uint64 mRequestID

protectedinherited

mFuture

boost::unique_future<void > mFuture

protectedinherited

---

The documentation for this class was generated from the following file:

• include/can/SDOFuture.h