lely::canopen::SdoUploadRequest< T > Class Template Reference

An SDO upload (i.e., read) request. More...

#include <sdo.hpp>

Inheritance diagram for lely::canopen::SdoUploadRequest< T >:

Collaboration diagram for lely::canopen::SdoUploadRequest< T >:

Public Types
using	Signature
	The signature of the callback function invoked on completion of an SDO upload request.

Public Member Functions
template<class F>
	SdoUploadRequest (ev_exec_t *exec, F &&con)
	Constructs an empty SDO upload request.
Public Member Functions inherited from lely::canopen::detail::SdoRequestBase
ev::Executor	GetExecutor () const noexcept
	Returns the executor to which the completion task is (to be) submitted.

Additional Inherited Members
Data Fields inherited from lely::canopen::detail::SdoUploadRequestBase< T >
T	value {}
	The value received from the SDO server.
Data Fields inherited from lely::canopen::detail::SdoRequestBase
uint8_t	id {0}
	The node-ID.
uint16_t	idx {0}
	The object index.
uint8_t	subidx {0}
	The object sub-index.
bool	block {false}
	A flag specifying whether the request should use a block SDO instead of a segmented (or expedited) SDO.
::std::chrono::milliseconds	timeout
	The SDO timeout.
::std::error_code	ec
	The SDO abort code (0 on success).
Data Fields inherited from ev_task
ev_exec_t *	exec
	A pointer to the executor to which the task is (to be) submitted.
ev_task_func_t *	func
	The function to be invoked when the task is run.

Detailed Description

template<class T>
class lely::canopen::SdoUploadRequest< T >

An SDO upload (i.e., read) request.

Definition at line 361 of file sdo.hpp.

Member Typedef Documentation

Signature

template<class T>

using lely::canopen::SdoUploadRequest< T >::Signature

Initial value:

 void(uint8_t id, uint16_t idx, uint8_t subidx,
                         ::std::error_code ec, T value)

The signature of the callback function invoked on completion of an SDO upload request.

Note that the callback function SHOULD NOT throw exceptions. Since it is invoked from C, any exception that is thrown cannot be caught and will result in a call to std::terminate().

Parameters

id	the node-ID.
idx	the object index.
subidx	the object sub-index.
ec	the SDO abort code (0 on success).
value	the value received from the SDO server.

Definition at line 375 of file sdo.hpp.

Constructor & Destructor Documentation

SdoUploadRequest()

template<class T>

template<class F>

lely::canopen::SdoUploadRequest< T >::SdoUploadRequest ( ev_exec_t * exec, F && con )

inline

Constructs an empty SDO upload request.

The object index and sub-index and, optionally, the SDO block flag and timeout have to be set before the request can be submitted.

Definition at line 384 of file sdo.hpp.

---

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

• include/lely/coapp/sdo.hpp
• src/coapp/sdo.cpp