libuav original

Dependents:   UAVCAN UAVCAN_Subscriber

Embed: (wiki syntax)

« Back to documentation index

Dispatcher Class Reference

Dispatcher Class Reference

This class performs low-level CAN frame routing. More...

#include <dispatcher.hpp>

Inherits uavcan::Noncopyable.

Public Member Functions

int spin (MonotonicTime deadline)
 This version returns strictly when the deadline is reached.
int spinOnce ()
 This version does not return until all available frames are processed.
int send (const Frame &frame, MonotonicTime tx_deadline, MonotonicTime blocking_deadline, CanTxQueue::Qos qos, CanIOFlags flags, uint8_t iface_mask)
 Refer to CanIOManager::send() for the parameter description.
NodeID getNodeID () const
 Node ID can be set only once.
bool isPassiveMode () const
 Refer to the specs to learn more about passive mode.
const LinkedListRoot
< TransferListener > & 
getListOfMessageListeners () const
 These methods can be used to retreive lists of messages, service requests and service responses the dispatcher is currently listening to.

Detailed Description

This class performs low-level CAN frame routing.

Definition at line 80 of file dispatcher.hpp.


Member Function Documentation

const LinkedListRoot<TransferListener>& getListOfMessageListeners (  ) const

These methods can be used to retreive lists of messages, service requests and service responses the dispatcher is currently listening to.

Note that the list of service response listeners is very volatile, because a response listener will be removed from this list as soon as the corresponding service call is complete.

Definition at line 188 of file dispatcher.hpp.

NodeID getNodeID (  ) const

Node ID can be set only once.

Non-unicast Node ID puts the node into passive mode.

Definition at line 222 of file dispatcher.hpp.

bool isPassiveMode (  ) const

Refer to the specs to learn more about passive mode.

Definition at line 228 of file dispatcher.hpp.

int send ( const Frame &  frame,
MonotonicTime  tx_deadline,
MonotonicTime  blocking_deadline,
CanTxQueue::Qos  qos,
CanIOFlags  flags,
uint8_t  iface_mask 
)

Refer to CanIOManager::send() for the parameter description.

Definition at line 287 of file uc_dispatcher.cpp.

int spin ( MonotonicTime  deadline )

This version returns strictly when the deadline is reached.

Definition at line 221 of file uc_dispatcher.cpp.

int spinOnce (  )

This version does not return until all available frames are processed.

Definition at line 252 of file uc_dispatcher.cpp.