NetBurner 3.5.8
PDF Version
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
 Cos_fifo_el::[union].__unnamed0__This struture is a union of a pointer to the next OS_FIFO and a byte pointer to the same data
 CSEMC_cfg_t::[union].__unnamed0__Control Register 0 - Basic Interface Configuration
 CSEMC_cfg_t::[union].__unnamed1__Control Register 1 - Primary Timing Configuration
 CSEMC_cfg_t::[union].__unnamed2__Control Register 2 - Extended Timing Configuration
 C_EthernetFrameHeaderEthernet Type II Frame Header
 C_FastPinVectorFastIO GPIO Pin Vector Base Class
  CFastPinVector< n >FastIO GPIO Pin Vector Class FastPinVector is a template instantiation of the _FastPinVector class, allowing for minimal storage requirements for potentially large vectors, without heavy code duplication due to template copies
  CFastPinVector< n >FastIO GPIO Pin Vector Class FastPinVector is a template instantiation of the _FastPinVector class, allowing for minimal storage requirements for potentially large vectors, without heavy code duplication due to template copies
 C_FlexSPIConfigFlexSPI Memory Configuration Block
 C_IpHeaderIPv4IP Header Structure (IPv4)
 C_lpspi_master_edma_private_handleStructure definition for dspi_master_edma_private_handle_t. The structure is private
 C_lut_sequenceFlexSPI LUT Sequence structure
 C_PinVectorGPIO Pin Vector Base Class
  CPinVector< 4 >
  CPinVector< 4 >
  CPinVector< 4 >
  CPinVector< n >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
  CPinVector< n >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
  CPinVector< n >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
 Caes_contextAES context structure
 CARM_MPU_Region_t
 CARPAddress Resolution Protocol packet structure
 CBBI2CSoftware (bit-banged) I2C master driver
 Cbuffer_listDoubly-linked list management for buffers
 Cbuffer_objectBase class for web client response buffers
  CParsedJsonDataSetA class to create, read, and modify a JSON object
   CJsonLexerFDAdapterGet the type name of the JSON primitive type passed in
  CSimpleBufferObjectClass for web client response buffers
  CStringBufferObjectClass for NBString-based web client response buffers
 CcanMCF5441x::CanRxMessageClass to hold received CAN messages
 CmcanMODM7AE70::CanRxMessageClass to hold received CAN messages
 CCertGenDataUsed 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
 CMQTT::ClientAdvanced 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
  CMQTT::ConfiguredClientEasy 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
 Cconfig_objBase class used to create configuration objects
  CCertData
  CGPSAssistConfig
  CI4Record
  CI6Record
  CInterfaceBlockNetwork interface configuration block class for interface control and configuration
  Cconfig_chooserChooser Configuration Variable - Select From a List of Items
  Csnmp_configSNMP agent configuration stored in the system configuration framework
 Cconfig_valueBase class used to create a configuration value
  CCUR_IPADDR4
  CDynamic_IPADDRDynamic_IPADDR
  Cconfig_IPADDRConfiguration Variable for IPADDR (IPv6) object type
  Cconfig_IPADDR4Configuration Variable for IPADDR4 (IPv4) object types
  Cconfig_MACADRConfiguration Variable for MACADR object type
  Cconfig_boolBoolean Configuration Variable
  Cconfig_doubleDouble Float Configuration Variable
   Cconfig_double_limitA 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_intSigned 32-bit Integer Configuration Variable
   Cconfig_int_limitA 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_stringString Configuration Variable
   Cconfig_localnameConfigure device network name
   Cconfig_passPassword string Configuration Variable
    Cconfig_pass_limitA 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_limitA 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_tClass to hold time configuration
  Cconfig_uintUnsigned 32-bit Integer Configuration Variable
   Cconfig_uint_limitA 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
 CMQTT::ConnectRequestStructure used to specify details for a Publish call
 CdCDC_ACMUSB CDC Abstract Control Model Device Class
 CdCDC_NCMUSB CDC NCM Device Class for Ethernet-over-USB
 CDelayObjectHigh-resolution microsecond delay timer class
 CDHCP::DhcpInfoDHCP Info
 CDHCP::DhcpLeaseDataLease Data
 CDHCP::DhcpLeaseRequestLease Request
 CDhcpObjectDHCP client class
 CDiagItemClassBase class for all diagnostic items
  CAcmeServletObjectMain ACME Client Class
   CBuyPassAcmeServletObjectACME Client for BuyPass
   CLetsEncryptAcmeServletObjectACME Client for Let's Encrypt
  CDiagCallBackCallback-based diagnostic item that calls a custom function to generate diagnostic content
  CDiagPtrMonMonitor and report pointer values
  CDiagStrMonMonitor and report string values
  CDiagVarMonMonitor and report the value of numeric variables
 CNB::Wifi::driverStatusStruct
 CdspiDMAStructDSPI DMA structure
 CdspiDriverStructMajor variables/configurations used for a DSPI transfer
 CDSPIModuleDSPIModule is a SPI communications driver. It is an object based driver, which allows for low overhead multiplexing between peripherals with different bus configurations
 CEBI_CS_cfg_tConfiguration structure for an External Bus Interface (EBI) chip select
 CEffs_CfgFilesystem Configuration
 CFastIOFast GPIO Pin Class
 CFastIOPortAArrayAccessor class for GPIO Port A: FastPortA[n] returns the FastIO for pin n of Port A
 CFastIOPortBArrayAccessor class for GPIO Port B: FastPortB[n] returns the FastIO for pin n of Port B
 CFastIOPortCArrayAccessor class for GPIO Port C: FastPortC[n] returns the FastIO for pin n of Port C
 CFastIOPortDArrayAccessor class for GPIO Port D: FastPortD[n] returns the FastIO for pin n of Port D
 CFastIOPortEArrayAccessor class for GPIO Port E: FastPortE[n] returns the FastIO for pin n of Port E
 CFastIOPortFArrayAccessor class for GPIO Port F: FastPortF[n] returns the FastIO for pin n of Port F
 CFastIOPortGArrayAccessor class for GPIO Port G: FastPortG[n] returns the FastIO for pin n of Port G
 CFastIOPortHArrayAccessor class for GPIO Port H: FastPortH[n] returns the FastIO for pin n of Port H
 CFastIOPortIArrayAccessor class for GPIO Port I: FastPortI[n] returns the FastIO for pin n of Port I
 CFastIOPortJArrayAccessor class for GPIO Port J: FastPortJ[n] returns the FastIO for pin n of Port J
 CFastIOPortKArrayAccessor class for GPIO Port K: FastPortK[n] returns the FastIO for pin n of Port K
 Cfifo_buffer_storageFIFO buffer storage using linked pool buffers
 CHtmlPageHandlerBase class for HTTP request handlers that process requests for specific URLs and HTTP methods
  CCallBackFunctionPageHandlerImplements the HtmlPageHandler class as a function pointer callback for GET requests
 CHTTP_RequestHTTP Request Structure
 CIEEE1588Timer
 CIPADDR4Used to store and manipulate IPv4 addresses in dual stack mode
 CIPADDR6Used to hold and manipulate IPv4 and IPv6 addresses in dual stack mode
 CIPPKTInternal IPv4 Header Representation
 CIPV6_ROOT_ELBase class for all IPv6 interface elements
  CIPV6_DESTIPv6 destination cache element
  CIPV6_DHCPDDHCPv6 server information element
  CIPV6_DNSIPv6 DNS server information element
  CIPV6_IA_ADDRDHCPv6 Identity Association address element
  CIPV6_NEIGHBORIPv6 neighbor cache element
  CIPV6_PREFIXIPv6 prefix and address management element
  CIPV6_ROUTERIPv6 router information element
 CIPV6_ROOT_EL_CONTAINERContainer for managing collections of IPv6 root elements
 CIPv6FrameProcessingStructIPv6 frame processing structure for packet analysis and header walking
 CIPv6InterfaceMain IPv6 interface management class
 CJsonAllocStringA list of large strings that are created with malloc
 CJsonRefRepresents a positional reference (pointer) of a location inside a ParsedJsonDataSet object
 CDHCP::LeaseAllocatorBase class/interface for lease allocators for the DHCP server
  CDHCP::BlockAllocatorBasic allocator that handles multiple leases in a contiguous IP block
   CDHCP::MacPrefixAllocatorDerived from BlockAllocator Has the ability to whitelist/blacklist certain mac address ranges based on a mask. Useful for allocating addresses based on device manufacturer
  CDHCP::SingleAllocatorStripped down allocator Fails to conform to many standard behaviors, but shows the basics of what needs to be implemented
 Clisten_list_itemStructure to use to create custom lists of listentiing ports and interfaces
 CMACADRUsed to store and manipulate MAC addresses
 CmcanMODM7AE70::mcan_configMCAN configuration structure
 Cmcan_extended_message_filter_elementMCAN extended message ID filter element structure
 CmcanMODM7AE70::mcan_moduleMCAN Module Class
 Cmcan_rx_element_bufferMCAN receive element structure for buffer
 Cmcan_tx_elementMCAN transfer element structure
 Cmcan_tx_event_elementMCAN transfer event FIFO element structure
 CMQTT::mqtt_leafBase 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::ConfigExposerEasy MqttObj class for automatically publishing and subscribing NetBurner Config system objects to/from an MQTT topic. Use like a normal ConfigObj
  CMQTT::SubHandlerEasy class for registering a callback function that receives messages on an MQTT topic and handles them appropriately. Behaves similarly to HttpResponseHandler
  CMQTT::mqtt_IOEasy MqttObj class for automatically publishing and subscribing hardware GPIO pins to/from an MQTT topic. Use like a normal PinIO
   CMQTT::mqtt_IO_InputMqttObj connecting hardware GPIO pins to an Mqtt Broker. This class defaults the pin to an Input state
   CMQTT::mqtt_IO_OutputMqttObj connecting hardware GPIO pins to an Mqtt Broker. This class defaults the pin to an Output state
  CMQTT::mqtt_boolEasy MqttObj class for automatically publishing and subscribing boolean values to/from an MQTT topic. Use like a normal bool
  CMQTT::mqtt_floatEasy MqttObj class for automatically publishing and subscribing floating point values to/from an MQTT topic. Use like a normal double
  CMQTT::mqtt_intEasy MqttObj class for automatically publishing and subscribing unsigned integer values to/from an MQTT topic. Use like a normal int32_t
  CMQTT::mqtt_objBase class for easy MQTT Objects (MqttObj). mqtt_obj are comprised of higher order parent objects that contain registered child objects
  CMQTT::mqtt_stringEasy MqttObj class for automatically publishing and subscribing string values to/from an MQTT topic. Use like a normal NBString
  CMQTT::mqtt_uintEasy MqttObj class for automatically publishing and subscribing unsigned integer values to/from an MQTT topic. Use like a normal uint32_t
 CMQTT::PacketInfo::MsgPacketInfo::Msg message data structure
 CNBRtosInitObjA simple class to derive from if you are creating tasks that are constructed at global scope and need to do RTOS initalization
 CNBStringLightweight alternative to C++ CString class
  CNBInterpolatedStringA wrapper for NBString::Interpolate() ideal for easy access to ephemeral values
 Cncm_ndp16_entry_tNCM NDP16 Datagram Entry
 Cncm_ndp16_tNCM NDP16 - 16-bit NCM Datagram Pointer
 Cncm_notification_network_tNCM Network Connection Notification
 Cncm_notification_speed_tNCM Connection Speed Change Notification
 Cncm_ntb_input_size_tNCM SET_NTB_INPUT_SIZE structure (when 8-byte form is used)
 Cncm_ntb_parameters_tNCM NTB Parameters Structure
 Cncm_nth16_tNCM NTH16 - 16-bit NCM Transfer Header
 CNTPServer
 CNTPServer::NtpTimeStamp
 COS_CRITAn 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_elOS_FIFO element definition
  Cpool_bufferMain buffer structure for network and serial communication
 COS_FLAGSOSFlags enables a function or task to pend on multiple flags or events
 COS_MBOXMailboxes single value storage locations used to communicate between tasks
 COS_QA 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_SEMSemaphores 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
 COSCriticalSectionObjA simple wrapper class that helps utilize OS_CRIT objects more effectively
 COSLockAndCritObjA simple wrapper class that helps utilize OS_CRIT objects to lock tasks and enter critical sections more effectively
 COSLockObjA simple wrapper class that helps use OS locks effectively
 COSSpinCritA 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
 CParsedURIParsed Uniform Resource Identifier Class (URI)
 CPartitionEntry
 CPartitionTable
 Cfifo_buffer_storage::PeekIteratorIterator for non-destructive examination of buffered data
 CPinIOGPIO Pin Class
 CPinIOArray2
 CPinIOArrayJ1
 CPinIOJ1Array
 CPinIOPortAArrayAccessor class for GPIO Port A: PortA[n] returns the PinIO for pin n of Port A
 CPinIOPortBArrayAccessor class for GPIO Port B: PortB[n] returns the PinIO for pin n of Port B
 CPinIOPortCArrayAccessor class for GPIO Port C: PortC[n] returns the PinIO for pin n of Port C
 CPinIOPortDArrayAccessor class for GPIO Port D: PortD[n] returns the PinIO for pin n of Port D
 CPinIOPortEArrayAccessor class for GPIO Port E: PortE[n] returns the PinIO for pin n of Port E
 CPinIOPortFArrayAccessor class for GPIO Port F: PortF[n] returns the PinIO for pin n of Port F
 CPinIOPortGArrayAccessor class for GPIO Port G: PortG[n] returns the PinIO for pin n of Port G
 CPinIOPortHArrayAccessor class for GPIO Port H: PortH[n] returns the PinIO for pin n of Port H
 CPinIOPortIArrayAccessor class for GPIO Port I: PortI[n] returns the PinIO for pin n of Port I
 CPinIOPortJArrayAccessor class for GPIO Port J: PortJ[n] returns the PinIO for pin n of Port J
 CPinIOPortKArrayAccessor class for GPIO Port K: PortK[n] returns the PinIO for pin n of Port K
 CPsudeoHeaderUDP/TCP IPv4 Pseudo-header Structure (bits 0 through 95 of the pseudo-header)
 CMQTT::PublishRequestStructure used to specify details for a Publish call
 CQSPI_RecordThis struct contains the major variables/configurations used for a QSPI transfer
 Cfifo_buffer_storage::ReadBufPtrRAII accessor for reading from buffer storage
 CReadLookUpObjectInternal read-side lookup record linking an OID to its dispatcher
 CSAI_cfg_tComplete configuration structure for the SAI driver
 CSAI_rxtx_cfg_tConfiguration structure for one direction (TX or RX) of the SAI module
 CSAICtx_tMain driver class for SAI peripheral operation
 CSEMC_cfg_tConfiguration structure for SEMC (Smart External Memory Controller) interface
 CSerialConfigServletClass to run serial configurator
 CSerialRecord
 CDHCP::ServerDHCP Server class Requires a lease allocator to be added in order to function
 CSMPoolPtrSmart pointer wrapper for automatic buffer management
 CSNMPReadObjectRegisters a scalar read callback with the SNMP agent
 CSnmpServletSNMP agent servlet that listens for and processes SNMP requests
 CSNMPWriteObjectRegisters a scalar write callback with the SNMP agent
 CspiDriverStructVariables/configurations for a DSPI transfer
 CSPIModuleSPI Peripheral Module Class
  CSPI_QSPIThe Single-Bit SPI mode QSPI Peripheral Class
  CSPI_USARTUSART in SPI mode Peripheral Module Class
 CSRAM_Timing_Spec_tTiming specifications for common SRAM speeds
 CSSC_cfg_tConfiguration structure for the SSC driver. Passed to the initialize function to configure the hardware
 CSSC_rxtx_cfg_tConfiguration structure for a given direction (rx or tx) of the SSC module. Passed to the initialize function to configure the hardware
 CSSCCtx_t
 CStopWatchHigh-resolution stopwatch timer for precise event timing and performance measurement
 CMQTT::SubscribeFilterStructure used to specify a topic filter for subscriptions
 CMQTT::SubscribeFilter_NbStrStructure used to specify a topic filter for subscriptions
 CMQTT::SubscribeRequestStructure used to specify details for a Subscribe call
 CTEMPL_Q< T >A convenience wrapper around OS_Q
 CTFTP_ServerTFTP Server Class
 CTFTP_Server_source_FileTFTP Server Source File
 Cusb_throughput_test.ThroughputStats
 CTickTimeoutTickTimeout 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
 CTimeZoneRecordTime zone record structure containing complete time zone information
 CMQTT::TopicHandlerTopicHandler context definition
 CTwoWireArduino Wire-compatible I2C controller/target interface
 CTwoWireObjectConvenience wrapper binding a TwoWire instance and device address
 CUDPPacketUDP Packet Class - Complete UDP packet management
 CUDPPKTInternal UDP Packet Header Structure
 CUniqueIdentifierGet the 128-bit Unique Identifier
 CUserAuthManagerThe 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
 CUserAuthRecordA 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
 CUSERCritObjUser critial section object class
 CWatchdogResetCause
 CWebConfigServletClass to run web configurator
 CNB::WebSocketWebSocket connection management class
 Cwifi_init
 CWifiInterfaceWiFi Interface clas
 CWM8904
 Cfifo_buffer_storage::WriteBufPtrRAII accessor for writing to buffer storage
 CWriteLookUpObjectInternal write-side lookup record linking an OID to its dispatcher