Руслан Урядинский
/
libuavcan
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: UAVCAN UAVCAN_Subscriber
Embed:
(wiki syntax)
Data Structures
Here are the data structures with brief descriptions:
| _dontescape | |
| ADC_CLOCK_SETUP_T | Clock setup structure for ADC controller passed to the initialize function |
| AllIfacesDownException | This exception is thrown when all available interfaces become down |
| AllocationRequestManager | This class manages communication with allocation clients |
| APSR_Type | Union type to access the Application Program Status Register (APSR) |
| Array< T, ArrayMode, MaxSize_ > | Generic array implementation |
| ArrayImpl< T, ArrayMode, MaxSize > | Common functionality for both static and dynamic arrays |
| ArrayImpl< IntegerSpec< 1, SignednessUnsigned, CastMode >, ArrayMode, MaxSize > | Memory-efficient specialization for bit arrays (each element maps to a single bit rather than single byte) |
| BasicFileServer | Basic file server implements only the following services: uavcan.protocol.file.GetInfo uavcan.protocol.file.Read Also see IFileServerBackend |
| BasicFileServerBackend | This interface implements a POSIX compliant IFileServerBackend interface |
| BitLenToByteLen< BitLen > | Compile-time: Returns the number of bytes needed to contain the given number of bits |
| BitSet< NumBits > | STL-like bitset |
| BitStream | This class treats a chunk of memory as an array of bits |
| BlockingServiceClient< DataType > | Wrapper over uavcan::ServiceClient<> for blocking calls |
| BooleanType< bool > | Value types |
| BusEvent | All bus events are reported as POLLIN |
| CanAcceptanceFilterConfigurator | This class configures hardware acceptance filters (if this feature is present on the particular CAN driver) to preclude reception of irrelevant CAN frames on the hardware level |
| CanDriver | This class implements CAN driver interface for libuavcan |
| CanDriver | CAN driver, incorporates all available CAN ifaces |
| CanFilterConfig | CAN hardware filter config struct |
| CanFrame | Raw CAN frame, as passed to/from the CAN driver |
| CanIface | Single CAN iface |
| CanInitHelper< RxQueueCapacity > | Helper class |
| CanRxItem | RX queue item |
| CanSelectMasks | Events to look for during ICanDriver::select() call |
| ClusterManager | This class maintains the cluster state |
| CoerceOrFallbackImpl< From, To > | CoerceOrFallback<To>(From) coerceOrFallback<To>(From, To) |
| CONTROL_Type | Union type to access the Control Registers (CONTROL) |
| CriticalSectionLocker | Locks UAVCAN driver interrupts |
| DataTypeDescriptor | This class contains complete description of a data type |
| DataTypeInfoProvider | This class implements the standard services for data type introspection |
| DataTypeSignatureCRC | CRC-64-WE Description: http://reveng.sourceforge.net/crc-catalogue/17plus.htm#crc.cat-bits.64 Initial value: 0xFFFFFFFFFFFFFFFF Poly: 0x42F0E1EBA9EA3693 Reverse: no Output xor: 0xFFFFFFFFFFFFFFFF Check: 0x62EC59E3F1A4F00A |
| DefaultDataTypeRegistrator< Type > | This class is used by autogenerated data types to register with the data type registry automatically before main() is called |
| DefaultLogSink | Default log sink will dump everything into stderr |
| Dispatcher | This class performs low-level CAN frame routing |
| DriverPack | Contains all drivers needed for uavcan::Node |
| DynamicNodeIDClient | This class implements client-side logic of dynamic node ID allocation procedure |
| EnableIf< B, T > | Compile time conditions |
| EnableIfType< T, R > | Lightweight type categorization |
| EnumMax< A, B > | Selects larger value |
| EnumMin< A, B > | Selects smaller value |
| EvalPseudoSandbox | |
| Exception | This is the root exception class for all exceptions that can be thrown from the libuavcan Linux driver |
| FileEventTracer | This interface implements a POSIX compliant file based IEventTracer interface |
| FileServer | Full file server implements all file services: uavcan.protocol.file.GetInfo uavcan.protocol.file.Read uavcan.protocol.file.Write uavcan.protocol.file.Delete uavcan.protocol.file.GetDirectoryEntryInfo Also see IFileServerBackend |
| FileStorageBackend | This interface implements a POSIX compliant IStorageBackend interface |
| FirmwareUpdateTrigger | This class subscribes to updates from NodeInfoRetriever in order to detect nodes that need firmware updates |
| FirmwareVersionChecker | Firmware version checking logic |
| GenericPublisher< DataSpec, DataStruct > | Generic publisher, suitable for messages and services |
| 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 |
| GlobalDataTypeRegistry | This singleton is shared among all existing node instances |
| GlobalTimeSyncMaster | Please read the specs to learn how the time synchronization works |
| GlobalTimeSyncSlave | Please read the specs to learn how the time synchronization works |
| HeapBasedPoolAllocator< BlockSize, RaiiSynchronizer > | A special-purpose implementation of a pool allocator that keeps the pool in the heap using malloc()/free() |
| I2C_XFER_T | Master transfer data structure definitions |
| IAdHocNodeStatusUpdater | This optional interface can be implemented by the user in order to update the node status as necessary, immediately before the next NodeStatus message is emitted by NodeStatusProvider |
| IAllocationRequestHandler | The main allocator must implement this interface |
| ICanDriver | Generic CAN driver |
| ICanIface | Single non-blocking CAN interface |
| IEventTracer | This interface allows the application to trace events that happen in the server |
| IFileServerBackend | The file server backend should implement this interface |
| IFirmwareVersionChecker | Application-specific firmware version checking logic |
| ILogSink | External log sink interface |
| IncomingTransfer | Container for received transfer |
| INode | Abstract node class |
| INodeDiscoveryHandler | The allocator must implement this interface |
| INodeInfoListener | Classes that need to receive GetNodeInfo responses should implement this interface |
| IntegerBitLen< Num > | Compile-time: Returns the number of bits needed to represent an integer value |
| IntegerSpec< BitLen_, Signedness, CastMode > | This template will be used for signed and unsigned integers more than 1 bit long |
| IntegerSpec< 1, SignednessUnsigned, CastMode > | Boolean specialization |
| IParamManager | Implement this interface in the application to support the standard remote reconfiguration services |
| IPoolAllocator | This interface is used by other library components that need dynamic memory |
| IPSR_Type | Union type to access the Interrupt Program Status Register (IPSR) |
| IRaftLeaderMonitor | Allocator has to implement this interface so the RaftCore can inform it when a new entry gets committed to the log |
| IRestartRequestHandler | Implement this interface in the application to support the standard node restart service |
| IRxFrameListener | Implement this interface to receive notifications about all incoming CAN frames, including loopback |
| IsDynamicallyAllocatable< T > | This class that allows to check at compile time whether type T can be allocated using the memory pool |
| IsImplicitlyConvertibleFromTo< T1, T2 > | Relations |
| IsPrimitiveType< T > | Compile-time: Whether T is a primitive type on this platform |
| IsSameType< T, U > | Checks if two identifiers refer to the same type |
| IStorageBackend | This interface is used by the server to read and write stable storage |
| ISystemClock | System clock interface - monotonic and UTC |
| ITransferAcceptanceFilter | This class is used by transfer listener to decide if the frame should be accepted or ignored |
| ITransferBuffer | API for transfer buffer users |
| LazyConstructor< T > | This class allows to postpone the object contruction |
| LibuavcanErrorException | This type is thrown when a Libuavcan API method exits with error |
| LimitedPoolAllocator | Limits the maximum number of blocks that can be allocated in a given allocator |
| LinkedListNode< T > | Classes that are supposed to be linked-listed should derive this |
| LinkedListRoot< T > | Linked list root |
| LoaderFile | |
| LoaderString | |
| Log | Raft log |
| RaftCore::LogEntryInfo | This class is used to perform log searches |
| Logger | Node logging convenience class |
| LoopbackFrameListenerBase | Inherit this class to receive notifications about all TX CAN frames that were transmitted with the loopback flag |
| LPC_ADC_T | 10 or 12-bit ADC register block structure |
| LPC_FMC_T | FLASH Memory Controller Unit register block structure |
| LPC_GPIO_T | GPIO port register block structure |
| LPC_GPIOGROUPINT_T | GPIO grouped interrupt register block structure |
| LPC_I2C_T | I2C register block structure |
| LPC_IOCON_T | IO Configuration Unit register block structure |
| LPC_PIN_INT_T | LPC11xx Pin Interrupt and Pattern Match register block structure |
| LPC_PMU_T | LPC11xx Power Management Unit register block structure |
| LPC_ROM_API_T | LPC11XX High level ROM API structure |
| LPC_SSP_T | SSP register block structure |
| LPC_SYSCTL_T | LPC11XX System Control block structure |
| LPC_TIMER_T | 32-bit Standard timer register block structure |
| LPC_USART_T | USART register block structure |
| LPC_WWDT_T | Windowed Watchdog register block structure |
| MachineIDReader | This class can find and read machine ID from a text file, represented as 32-char (16-byte) long hexadecimal string, possibly with separators (like dashes or colons) |
| MakeString< MaxSize > | Shortcut for string-like array type instantiation |
| Map< Key, Value > | Slow but memory efficient KV container |
| MethodBinder< ObjectPtr, MemFunPtr > | Use this to call member functions as callbacks in C++03 mode |
| MultiFrameIncomingTransfer | Internal |
| Multiset< T > | Slow but memory efficient unordered multiset |
| Node< MemPoolSize > | This is the top-level node API |
| Node | Wrapper for uavcan::Node with some additional convenience functions |
| NodeBase< NodeType > | Generic wrapper for node objects with some additional convenience functions |
| NodeDiscoverer | This class listens to NodeStatus messages from other nodes and retrieves their unique ID if they are not known to the allocator |
| NodeIDSelector< Owner > | Node ID allocation logic |
| NodeInfoRetriever | This class automatically retrieves a response to GetNodeInfo once a node appears online or restarts |
| NodeStatusMonitor | This class implements the core functionality of a network monitor |
| NodeStatusProvider | Provides the status and basic information about this node to other network participants |
| Noncopyable | Prevents copying when inherited |
| NullAllocator | Zero allocator - always fails |
| NumericTraits< bool > | Bool |
| NumericTraits< char > | Char |
| NumericTraits< double > | Double |
| NumericTraits< float > | Float |
| NumericTraits< int > | Int |
| NumericTraits< long > | Long |
| NumericTraits< long double > | Long double |
| NumericTraits< long long > | Long long |
| NumericTraits< short > | Short |
| NVIC_Type | Structure type to access the Nested Vectored Interrupt Controller (NVIC) |
| OStream | Compact replacement for std::ostream for use on embedded systems |
| OutgoingTransferRegistry | Outgoing transfer registry keeps track of Transfer ID values for all currently existing local transfer senders |
| PanicBroadcaster | Helper for broadcasting the message uavcan.protocol.Panic |
| ParameterType< U > | Parameter types |
| ParamServer | Convenience class for supporting the standard configuration services |
| Parser | |
| PersistentState | This class is a convenient container for persistent state variables defined by Raft |
| PoolAllocator< PoolSize, BlockSize, RaiiSynchronizer > | Classic implementation of a pool allocator (Meyers) |
| Publisher< DataType_ > | Use this class to publish messages to the bus (broadcast, unicast, or both) |
| RaftCore | This class implements log replication and voting |
| ReceivedDataStructure< DataType_ > | This class extends the data structure with extra information obtained from the transport layer, such as Source Node ID, timestamps, Transfer ID, index of the interface this transfer was picked up from, etc |
| RemoveReference< T > | Remove reference as in <type_traits> |
| Renderer | |
| RestartRequestServer | Convenience class for supporting the standard node restart service |
| RINGBUFF_T | Ring buffer structure |
| ScalarCodec | This class implements fast encoding/decoding of primitive type scalars into/from bit arrays |
| SCB_Type | Structure type to access the System Control Block (SCB) |
| Scheduler | This class distributes processing time between library components (IO handling, deadline callbacks, ...) |
| Server | This server is an alternative to DistributedServer with the following differences:
|
| Server | This class implements the top-level allocation logic and server API |
| ServiceCallID | This struct describes a pending service call |
| ServiceCallResult< DataType > | Object of this type will be returned to the application as a result of service call |
| ServiceClientBase | Do not use directly |
| ServiceResponseDataStructure< ResponseDataType_ > | This type can be used in place of the response type in a service server callback to get more advanced control of service request processing |
| SingleFrameIncomingTransfer | Internal |
| SocketCanDriver | Multiplexing container for multiple SocketCAN sockets |
| SocketCanIface | Single SocketCAN socket interface |
| SquareMatrixAnalyzer< ElementIterator, NumElements > | This class can be used to detect properties of square matrices |
| SquareMatrixTraits< NumElements_ > | Properties of a square matrix; assuming row-major representation |
| StateReport | This structure represents immediate state of the server |
| StaticTransferBufferImpl | Standalone static buffer |
| Storage | This class transparently replicates its state to the storage backend, keeping the most recent state in memory |
| StorageMarshaller | This class extends the storage backend interface with serialization/deserialization functionality |
| StorageType< T, Enable > | Compile-time: Helper for integer and float specialization classes |
| SubNode< MemPoolSize > | This node object can be used in multiprocess UAVCAN nodes |
| SubNode | Wrapper for uavcan::SubNode with some additional convenience functions |
| SystemClock | Adapter for uavcan::ISystemClock |
| SystemClock | Linux system clock driver |
| SystemClock | Adapter for uavcan::ISystemClock |
| SysTick_Type | Structure type to access the System Timer (SysTick) |
| Template | |
| TemplateBase | |
| TemplateException | |
| TemplateIncludeError | |
| TemplateParseError | |
| TemplateRenderError | |
| TemplateSyntaxError | |
| TestListener | This subscriber accepts any types of transfers - this makes testing easier |
| TimerBase | Inherit this class if you need a timer callback method in your class |
| TimerEvent | Objects of this type will be supplied into timer callbacks |
| TimerEventForwarder< Callback_ > | Wrapper over TimerBase that forwards callbacks into arbitrary handlers, like functor objects, member functions or static functions |
| Transfer | UAVCAN transfer representation used in various tests |
| TransferBufferAccessor | Convinience class |
| TransferBufferManager | Buffer manager implementation |
| TransferBufferManagerEntry | Resizable gather/scatter storage |
| TransferBufferManagerKey | Internal for TransferBufferManager |
| TransferCRC | CRC-16-CCITT Initial value: 0xFFFF Poly: 0x1021 Reverse: no Output xor: 0 |
| TransferListener | Internal, refer to the transport dispatcher class |
| TransferListenerWithFilter | This class should be derived by callers |
| TransferPerfCounter | The class is declared noncopyable for two reasons:
|
| TransportStatsProvider | This class provides statistics about the transport layer performance on the local node |
| UtcSyncParams | UTC clock synchronization parameters |
| UtcTime | Implicitly convertible to/from uavcan.Timestamp |
| xPSR_Type | Union type to access the Special-Purpose Program Status Registers (xPSR) |
| YamlStreamer< Array< T, ArrayMode, MaxSize > > | YAML streamer specification for any Array<> |
Generated on Tue Jul 12 2022 17:17:36 by
1.7.2