Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 123]

►NcanMCF5441x	CanMCF5441x namespace
CCanRxMessage	Class to hold received CAN messages
►NDHCP	DHCP Namespace
CBlockAllocator	Basic allocator that handles multiple leases in a contiguous IP block
CDhcpInfo	DHCP Info
CDhcpLeaseData	Lease Data
CDhcpLeaseRequest	Lease Request
CLeaseAllocator	Base class/interface for lease allocators for the DHCP server
CMacPrefixAllocator	Derived from BlockAllocator Has the ability to whitelist/blacklist certain mac address ranges based on a mask. Useful for allocating addresses based on device manufacturer
CServer	DHCP Server class Requires a lease allocator to be added in order to function
CSingleAllocator	Stripped down allocator Fails to conform to many standard behaviors, but shows the basics of what needs to be implemented
►NmcanMODM7AE70	McanMODM7AE70 namespace
CCanRxMessage	Class to hold received CAN messages
Cmcan_config	MCAN configuration structure
Cmcan_module	MCAN Module Class
►NMQTT	MQTT Namespace
►NPacketInfo	MQTT PacketInfo Namespace
CMsg	PacketInfo::Msg message data structure
CClient	Advanced low-level MQTT Client for interacting with Mqtt Brokers. The client handles all network communications with the Broker and handles local message queueing and dispatching to topic handlers
CConfigExposer	Easy MqttObj class for automatically publishing and subscribing NetBurner Config system objects to/from an MQTT topic. Use like a normal ConfigObj
CConfiguredClient	Easy MQTT Client wrapper for interacting with MQTT brokers. The client handles all network communications with the Broker and handles local message queueing and dispatching to topic handlers. Adds ConfigObj for automatically configuring all Client settings via the Config System
CConnectRequest	Structure used to specify details for a Publish call
Cmqtt_bool	Easy MqttObj class for automatically publishing and subscribing boolean values to/from an MQTT topic. Use like a normal bool
Cmqtt_float	Easy MqttObj class for automatically publishing and subscribing floating point values to/from an MQTT topic. Use like a normal double
Cmqtt_int	Easy MqttObj class for automatically publishing and subscribing unsigned integer values to/from an MQTT topic. Use like a normal int32_t
Cmqtt_IO	Easy MqttObj class for automatically publishing and subscribing hardware GPIO pins to/from an MQTT topic. Use like a normal PinIO
Cmqtt_IO_Input	MqttObj connecting hardware GPIO pins to an Mqtt Broker. This class defaults the pin to an Input state
Cmqtt_IO_Output	MqttObj connecting hardware GPIO pins to an Mqtt Broker. This class defaults the pin to an Output state
Cmqtt_leaf	Base class for all Mqtt Objects (MqttObj). Mqtt Objects provide a seamless bridge/synchronization to communicate information through an MQTT Broker via a Client object
Cmqtt_obj	Base class for easy MQTT Objects (MqttObj). mqtt_obj are comprised of higher order parent objects that contain registered child objects
Cmqtt_string	Easy MqttObj class for automatically publishing and subscribing string values to/from an MQTT topic. Use like a normal NBString
Cmqtt_uint	Easy MqttObj class for automatically publishing and subscribing unsigned integer values to/from an MQTT topic. Use like a normal uint32_t
CPublishRequest	Structure used to specify details for a Publish call
CSubHandler	Easy class for registering a callback function that receives messages on an MQTT topic and handles them appropriately. Behaves similarly to HttpResponseHandler
CSubscribeFilter	Structure used to specify a topic filter for subscriptions
CSubscribeFilter_NbStr	Structure used to specify a topic filter for subscriptions
CSubscribeRequest	Structure used to specify details for a Subscribe call
CTopicHandler	TopicHandler context definition
C_edma_channel_Preemption_config	EDMA channel priority configuration
C_edma_config	EDMA global configuration structure
C_edma_handle	EDMA transfer handle structure
C_edma_minor_offset_config	EDMA minor offset configuration
C_edma_tcd	EDMA TCD
C_edma_transfer_config	EDMA transfer configuration
C_EthernetFrameHeader	Ethernet Type II Frame Header
C_flexcan_config	FlexCAN module configuration structure
C_flexcan_fifo_transfer	FlexCAN Rx FIFO transfer
C_flexcan_frame	FlexCAN message frame structure
C_flexcan_handle	FlexCAN handle structure
C_flexcan_mb_transfer	FlexCAN Message Buffer transfer
C_flexcan_rx_fifo_config	FlexCAN Legacy Rx FIFO configuration structure
C_flexcan_rx_mb_config	FlexCAN Receive Message Buffer configuration structure
C_flexcan_timing_config	FlexCAN protocol timing characteristic configuration structure
C_FlexSPIConfig	FlexSPI Memory Configuration Block
C_IpHeaderIPv4	IP Header (IPv4)
C_lpspi_master_config	LPSPI master configuration structure
C_lpspi_master_edma_handle	LPSPI master eDMA transfer handle structure used for transactional API
C_lpspi_master_edma_private_handle	Structure definition for dspi_master_edma_private_handle_t. The structure is private
C_lpspi_master_handle	LPSPI master transfer handle structure used for transactional API
C_lpspi_slave_config	LPSPI slave configuration structure
C_lpspi_slave_edma_handle	LPSPI slave eDMA transfer handle structure used for transactional API
C_lpspi_slave_handle	LPSPI slave transfer handle structure used for transactional API
C_lpspi_transfer	LPSPI master/slave transfer structure
C_lut_sequence	FlexSPI LUT Sequence structure
C_PinVector	GPIO Pin Vector Base Class
C_pit_config	PIT configuration structure
C_qtmr_config	Quad Timer config structure
C_tempmon_config	TEMPMON temperature structure
CAcmeServletObject	Main ACME Client Class
Caes_context	AES context structure
CARM_MPU_Region_t
CBBI2C	I2C Peripheral Class
Cbuffer_list	Doubly-linked list management for buffers
Cbuffer_object	Base class for web client response buffers
CBuyPassAcmeServletObject	ACME Client for BuyPass
CCallBackFunctionPageHandler	Implements the HtmlPageHandler class as a function pointer callback for GET requests
CCallBackFunctionPostHandler	Implements the HtmlPostHandler class as a function pointer callback for POST requests
CCertData
CCertGenData	Used to store the information that is passed in when enabling onboard generated certificates, as well as the information needed to determine when they need to be regenerated
Cconfig_bool	Boolean Configuration Variable
Cconfig_chooser	Chooser Configuration Variable - Select From a List of Items
Cconfig_double	Double Float Configuration Variable
Cconfig_double_limit	A config_double with minimum and/or maximum values Attempting to set a value lower than the minimum or greater than the maximum will fail with an error both programmatically and in the Config Web UI
Cconfig_int	Signed 32-bit Integer Configuration Variable
Cconfig_int_limit	A config_int with minimum and/or maximum values Attempting to set a value lower than the minimum or greater than the maximum will fail with an error both programmatically and in the Config Web UI
Cconfig_IPADDR	Configuration Variable for IPADDR (IPv6) object type
Cconfig_IPADDR4	Configuration Variable for IPADDR4 (IPv4) object types
Cconfig_localname	Configure device network name
Cconfig_MACADR	Configuration Variable for MACADR object type
Cconfig_obj	Base class used to create configuration objects
Cconfig_pass	Password string Configuration Variable
Cconfig_pass_limit	A config_pass with minimum and/or maximum lengths Attempting to set a value shorter than the minimum or longer than the maximum will fail with an error both programmatically and in the Config Web UI
Cconfig_string	String Configuration Variable
Cconfig_string_limit	A config_string with minimum and/or maximum lengths Attempting to set a value shorter than the minimum or longer than the maximum will fail with an error both programmatically and in the Config Web UI
Cconfig_time_t	Class to hold time configuration
Cconfig_uint	Unsigned 32-bit Integer Configuration Variable
Cconfig_uint_limit	A config_uint with minimum and/or maximum values Attempting to set a value lower than the minimum or greater than the maximum will fail with an error both programmatically and in the Config Web UI
Cconfig_value	Base class used to create a configuration value
CCUR_IPADDR4
CDelayObject	Microsecond Delay Class
CDhcpObject	DHCP client class
CDiagCallBack	Callback-based diagnostic item that calls a custom function to generate diagnostic content
CDiagItemClass	Base class for all diagnostic items
CDiagPtrMon	Monitor and report pointer values
CDiagStrMon	Monitor and report string values
CDiagVarMon	Monitor and report the value of numeric variables
CdspiDMAStruct	DSPI DMA structure
CdspiDriverStruct	Major variables/configurations used for a DSPI transfer
CDSPIModule	DSPIModule is a SPI communications driver. It is an object based driver, which allows for low overhead multiplexing between peripherals with different bus configurations
CDynamic_IPADDR	Dynamic_IPADDR
CEBI_CS_cfg_t	Configuration structure for an External Bus Interface (EBI) chip select
CEffs_Cfg	Filesystem Configuration
►Cfifo_buffer_storage	FIFO buffer storage using linked pool buffers
CPeekIterator	Iterator for non-destructive examination of buffered data
CReadBufPtr	RAII accessor for reading from buffer storage
CWriteBufPtr	RAII accessor for writing to buffer storage
CHtmlPageHandler	Base class for all GET handlers. To handle GET requests for a specific URL in your application, build a GET handler object for that specifif URL. A NULL name will be a catch all for all GET requests
CHtmlPostVariableListCallback	Implements the HtmlPostVariableListHandler class as a function pointer callback for HTTP POST submissions
CHTTP_Request	HTTP Request Structure
CI2C	I2C Peripheral Class
CI2CDevice	I2C Device Class (recommended)
CI4Record
CI6Record
CIEEE1588Timer
CInterfaceBlock	Network interface configuration block class for interface control and configuration
CIPADDR4	Used to store and manipulate IPv4 addresses in dual stack mode
CIPADDR6	Used to hold and manipulate IPv4 and IPv6 addresses in dual stack mode
CIPPKT	Internal IPv4 Header
CIPV6_DEST	IPv6 destination cache element
CIPV6_DHCPD	DHCPv6 server information element
CIPV6_DNS	IPv6 DNS server information element
CIPV6_IA_ADDR	DHCPv6 Identity Association address element
CIPV6_NEIGHBOR	IPv6 neighbor cache element
CIPV6_PREFIX	IPv6 prefix and address management element
CIPV6_ROOT_EL	Base class for all IPv6 interface elements
CIPV6_ROOT_EL_CONTAINER	Container for managing collections of IPv6 root elements
CIPV6_ROUTER	IPv6 router information element
CIPv6FrameProcessingStruct	IPv6 frame processing structure for packet analysis and header walking
CIPv6Interface	Main IPv6 interface management class
CJsonAllocString	A list of large strings that are created with malloc
CJsonLexerFDAdapter	Get the type name of the JSON primitive type passed in
CJsonRef	Represents a positional reference (pointer) of a location inside a ParsedJsonDataSet object
CLetsEncryptAcmeServletObject	ACME Client for Let's Encrypt
Clisten_list_item	Structure to use to create custom lists of listentiing ports and interfaces
CMACADR	Used to store and manipulate MAC addresses
Cmcan_extended_message_filter_element	MCAN extended message ID filter element structure
Cmcan_rx_element_buffer	MCAN receive element structure for buffer
Cmcan_tx_element	MCAN transfer element structure
Cmcan_tx_event_element	MCAN transfer event FIFO element structure
CNBInterpolatedString	A wrapper for NBString::Interpolate() ideal for easy access to ephemeral values
CNBRtosInitObj	A simple class to derive from if you are creating tasks that are constructed at global scope and need to do RTOS initalization
CNBString	Lightweight alternative to C++ CString class
►CNTPServer
CNtpTimeStamp
COS_CRIT	An OS_CRIT object is used to establish critical sections of code that can only be run by one task at a time. Tasks that try to claim a critical section which is currently claimed by another task will stop and wait for that task to release the critical section before continuing execution
COS_FIFO
Cos_fifo_el	OS_FIFO element definition
COS_FLAGS	OSFlags enables a function or task to pend on multiple flags or events
COS_MBOX	Mailboxes single value storage locations used to communicate between tasks
COS_Q	A message queue is an object that enables tasks and interrupt service routines to pend and post pointer sized messages. The pointer values typically point to some type of object or structure that contains the actual message or data. A queue functions as a fixed size First In First Out (FIFO) storage for 32-bit void pointers that can be used for communication between tasks
COS_SEM	Semaphores are used to control access to shared resources or or to communicate between tasks in a multithreaded system or with interrupt service routines. Semaphores can be 0 or 1, or they can be counting semaphores that increment and decreement based on calls to Pend() and Post() functions
COSCriticalSectionObj	A simple wrapper class that helps utilize OS_CRIT objects more effectively
COSLockAndCritObj	A simple wrapper class that helps utilize OS_CRIT objects to lock tasks and enter critical sections more effectively
COSLockObj	A simple wrapper class that helps use OS locks effectively
COSSpinCrit	A simple wrapper class that uses an OS_CRIT object to try and claim a critical section, and will continue the attempt until it is able to do so
CParsedJsonDataSet	A class to create, read, and modify a JSON object
CParsedURI	Parsed Uniform Resource Identifier Class (URI)
CPartitionEntry
CPartitionTable
CPinIO	GPIO Pin Class
CPinIOArray2
CPinIOArrayJ1
CPinIOJ1Array
CPinVector	GPIO Pin Vector Class PinVector is a template instantiation of the _PinVector class, allowing for minimal storage requirements for potentially large vectors, without heavy code duplication due to template copies
Cpool_buffer	Main buffer structure for network and serial communication
CPsudeoHeader	UDP IPv4 Pseudo-header segment (bits 0 through 95)
CQSPI_Record	This struct contains the major variables/configurations used for a QSPI transfer
CSAI_cfg_t	Configuration structure for the SAI driver. Passed to the initialize function to configure the hardware
CSAI_rxtx_cfg_t	Configuration structure for a given direction (rx or tx) of the SAI module. Passed to the initialize function to configure the hardware
CSAICtx_t
CSerialConfigServlet	Class to run serial configurator
CSerialRecord
CSimpleBufferObject	Class for web client response buffers
CSMPoolPtr	Smart pointer wrapper for automatic buffer management
CSPI_QSPI	The Single-Bit SPI mode QSPI Peripheral Class
CSPI_USART	USART in SPI mode Peripheral Module Class
CspiDriverStruct	Variables/configurations for a DSPI transfer
CSPIModule	SPI Peripheral Module Class
CSSC_cfg_t	Configuration structure for the SSC driver. Passed to the initialize function to configure the hardware
CSSC_rxtx_cfg_t	Configuration structure for a given direction (rx or tx) of the SSC module. Passed to the initialize function to configure the hardware
CSSCCtx_t
CStopWatch	Stopwatch for timing events
CStringBufferObject	Class for NBString-based web client response buffers
CTEMPL_Q	A convenience wrapper around OS_Q
CTFTP_Server	TFTP Server Class
CTFTP_Server_source_File	TFTP Server Source File
CTickTimeout	TickTimeout objects are used to facilitate sequential function calls with timeout parameters that need to indexed from an initial start time, and to prevent TimeTick rollover errors
CTimeZoneRecord	Time zone record strucure. Provides an array of over 75 time zones in the TimeZoneRecord structure format. Time zones are described in \nburn\nbrtos\source\timezones.cpp
CTwoWire	Wire interface class
CUDPPacket	UDP Packet Class
CUDPPKT	Internal UDP Header
CUniqueIdentifier	Get the 128-bit Unique Identifier
CUserAuthManager	The user authorization manager class allows application developers the ability to manage user authorization records. The can be loaded and saved to any storage space, including the config system or UserParams. Authorization values are hashed before being saved. Validation compares both the hash as well as the authorization type. Adding, updating, and removing records will automatically call the user devined save functions. For usage, please see the example found in examples/SSH/sshServerUserAuth
CUserAuthRecord	A stored record of a user's authorization credentials. The value is hashed when saved so it can't be read directly. User's can currently only have one authorization record per user name
CUSERCritObj	User critial section object class
CWebConfigServlet	Class to run web configurator
Cwifi_init
CWifiInterface	WiFi Interface clas
CWireIntf	Wire Interface Class for I2C
CWM8904