uavcan::IncomingTransfer Class Reference

#include <transfer_listener.hpp>

Inheritance diagram for uavcan::IncomingTransfer:

Public Member Functions
uint8_t	getIfaceIndex () const
MonotonicTime	getMonotonicTimestamp () const
TransferPriority	getPriority () const
NodeID	getSrcNodeID () const
TransferID	getTransferID () const
TransferType	getTransferType () const
UtcTime	getUtcTimestamp () const
virtual bool	isAnonymousTransfer () const
virtual void	release ()
Public Member Functions inherited from uavcan::ITransferBuffer
virtual int	read (unsigned offset, uint8_t *data, unsigned len) const =0
virtual	~ITransferBuffer ()

Protected Member Functions
	IncomingTransfer (MonotonicTime ts_mono, UtcTime ts_utc, TransferPriority transfer_priority, TransferType transfer_type, TransferID transfer_id, NodeID source_node_id, uint8_t iface_index)

Private Member Functions
virtual int	write (unsigned offset, const uint8_t *data, unsigned len)
	That's a no-op, asserts in debug builds. More...

Private Attributes
uint8_t	iface_index_
NodeID	src_node_id_
TransferID	transfer_id_
TransferPriority	transfer_priority_
TransferType	transfer_type_
MonotonicTime	ts_mono_
UtcTime	ts_utc_

Detailed Description

Container for received transfer.

Definition at line 24 of file transfer_listener.hpp.

Constructor & Destructor Documentation

IncomingTransfer()

uavcan::IncomingTransfer::IncomingTransfer ( MonotonicTime  ts_mono, UtcTime  ts_utc, TransferPriority  transfer_priority, TransferType  transfer_type, TransferID  transfer_id, NodeID  source_node_id, uint8_t  iface_index  )

inlineprotected

Definition at line 38 of file transfer_listener.hpp.

Member Function Documentation

getIfaceIndex()

uint8_t uavcan::IncomingTransfer::getIfaceIndex ( ) const

inline

Definition at line 67 of file transfer_listener.hpp.

getMonotonicTimestamp()

MonotonicTime uavcan::IncomingTransfer::getMonotonicTimestamp ( ) const

inline

Definition at line 61 of file transfer_listener.hpp.

getPriority()

TransferPriority uavcan::IncomingTransfer::getPriority ( ) const

inline

Definition at line 63 of file transfer_listener.hpp.

getSrcNodeID()

NodeID uavcan::IncomingTransfer::getSrcNodeID ( ) const

inline

Definition at line 66 of file transfer_listener.hpp.

getTransferID()

TransferID uavcan::IncomingTransfer::getTransferID ( ) const

inline

Definition at line 65 of file transfer_listener.hpp.

getTransferType()

TransferType uavcan::IncomingTransfer::getTransferType ( ) const

inline

Definition at line 64 of file transfer_listener.hpp.

getUtcTimestamp()

UtcTime uavcan::IncomingTransfer::getUtcTimestamp ( ) const

inline

Definition at line 62 of file transfer_listener.hpp.

isAnonymousTransfer()

virtual bool uavcan::IncomingTransfer::isAnonymousTransfer ( ) const

inlinevirtual

Whether this is a anonymous transfer

Reimplemented in uavcan::SingleFrameIncomingTransfer.

Definition at line 59 of file transfer_listener.hpp.

release()

virtual void uavcan::IncomingTransfer::release ( )

inlinevirtual

Dispose the payload buffer. Further calls to read() will not be possible.

Reimplemented in uavcan::MultiFrameIncomingTransfer.

Definition at line 54 of file transfer_listener.hpp.

write()

int uavcan::IncomingTransfer::write ( unsigned  offset, const uint8_t *  data, unsigned  len  )

privatevirtual

That's a no-op, asserts in debug builds.

Implements uavcan::ITransferBuffer.

Definition at line 15 of file uc_transfer_listener.cpp.

Member Data Documentation

iface_index_

uint8_t uavcan::IncomingTransfer::iface_index_

private

Definition at line 32 of file transfer_listener.hpp.

src_node_id_

NodeID uavcan::IncomingTransfer::src_node_id_

private

Definition at line 31 of file transfer_listener.hpp.

transfer_id_

TransferID uavcan::IncomingTransfer::transfer_id_

private

Definition at line 30 of file transfer_listener.hpp.

transfer_priority_

TransferPriority uavcan::IncomingTransfer::transfer_priority_

private

Definition at line 28 of file transfer_listener.hpp.

transfer_type_

TransferType uavcan::IncomingTransfer::transfer_type_

private

Definition at line 29 of file transfer_listener.hpp.

ts_mono_

MonotonicTime uavcan::IncomingTransfer::ts_mono_

private

Definition at line 26 of file transfer_listener.hpp.

ts_utc_

UtcTime uavcan::IncomingTransfer::ts_utc_

private

Definition at line 27 of file transfer_listener.hpp.

---

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

• transfer_listener.hpp
• uc_transfer_listener.cpp