Руслан Урядинский / libuavcan

Dependents:   UAVCAN UAVCAN_Subscriber

Embed: (wiki syntax)

« Back to documentation index

GenericSubscriber< DataSpec, DataStruct, TransferListenerType > Class Template Reference

GenericSubscriber< DataSpec, DataStruct, TransferListenerType > Class Template Reference

Please note that the reference passed to the RX callback points to a stack-allocated object, which means that it gets invalidated shortly after the callback returns. More...

#include <generic_subscriber.hpp>

Inherits uavcan::GenericSubscriberBase.

Public Member Functions

uint32_t getFailureCount () const
 Returns the number of failed attempts to decode received message.

Protected Member Functions

void allowAnonymousTransfers ()
 By default, anonymous transfers will be ignored.
void stop ()
 Terminate the subscription.

Detailed Description

template<typename DataSpec, typename DataStruct, typename TransferListenerType>
class uavcan::GenericSubscriber< DataSpec, DataStruct, TransferListenerType >

Please note that the reference passed to the RX callback points to a stack-allocated object, which means that it gets invalidated shortly after the callback returns.

Definition at line 128 of file generic_subscriber.hpp.


Member Function Documentation

void allowAnonymousTransfers (  ) [protected]

By default, anonymous transfers will be ignored.

This option allows to enable reception of anonymous transfers.

Definition at line 204 of file generic_subscriber.hpp.

uint32_t getFailureCount (  ) const [inherited]

Returns the number of failed attempts to decode received message.

Generally, a failed attempt means either:

  • Transient failure in the transport layer.
  • Incompatible data types.

Definition at line 118 of file generic_subscriber.hpp.

void stop (  ) [protected]

Terminate the subscription.

Dispatcher core will remove this instance from the subscribers list.

Definition at line 213 of file generic_subscriber.hpp.