|
NetBurner 3.5.8
PDF Version |
| 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_EthernetFrameHeader | Ethernet Type II Frame Header |
| C_FastPinVector | FastIO 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_FlexSPIConfig | FlexSPI Memory Configuration Block |
| C_IpHeaderIPv4 | IP Header Structure (IPv4) |
| C_lpspi_master_edma_private_handle | Structure definition for dspi_master_edma_private_handle_t. The structure is private |
| C_lut_sequence | FlexSPI LUT Sequence structure |
| C_PinVector | GPIO 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_context | AES context structure |
| CARM_MPU_Region_t | |
| CARP | Address Resolution Protocol packet structure |
| CBBI2C | Software (bit-banged) I2C master driver |
| Cbuffer_list | Doubly-linked list management for buffers |
| Cbuffer_object | Base class for web client response buffers |
| CParsedJsonDataSet | A class to create, read, and modify a JSON object |
| CJsonLexerFDAdapter | Get the type name of the JSON primitive type passed in |
| CSimpleBufferObject | Class for web client response buffers |
| CStringBufferObject | Class for NBString-based web client response buffers |
| CcanMCF5441x::CanRxMessage | Class to hold received CAN messages |
| CmcanMODM7AE70::CanRxMessage | Class to hold received CAN messages |
| 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 |
| CMQTT::Client | 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 |
| CMQTT::ConfiguredClient | 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 |
| Cconfig_obj | Base class used to create configuration objects |
| CCertData | |
| CGPSAssistConfig | |
| CI4Record | |
| CI6Record | |
| CInterfaceBlock | Network interface configuration block class for interface control and configuration |
| Cconfig_chooser | Chooser Configuration Variable - Select From a List of Items |
| Csnmp_config | SNMP agent configuration stored in the system configuration framework |
| Cconfig_value | Base class used to create a configuration value |
| CCUR_IPADDR4 | |
| CDynamic_IPADDR | Dynamic_IPADDR |
| Cconfig_IPADDR | Configuration Variable for IPADDR (IPv6) object type |
| Cconfig_IPADDR4 | Configuration Variable for IPADDR4 (IPv4) object types |
| Cconfig_MACADR | Configuration Variable for MACADR object type |
| Cconfig_bool | Boolean Configuration Variable |
| 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_string | String Configuration Variable |
| Cconfig_localname | Configure device network name |
| 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_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 |
| CMQTT::ConnectRequest | Structure used to specify details for a Publish call |
| CdCDC_ACM | USB CDC Abstract Control Model Device Class |
| CdCDC_NCM | USB CDC NCM Device Class for Ethernet-over-USB |
| CDelayObject | High-resolution microsecond delay timer class |
| CDHCP::DhcpInfo | DHCP Info |
| CDHCP::DhcpLeaseData | Lease Data |
| CDHCP::DhcpLeaseRequest | Lease Request |
| CDhcpObject | DHCP client class |
| CDiagItemClass | Base class for all diagnostic items |
| CAcmeServletObject | Main ACME Client Class |
| CBuyPassAcmeServletObject | ACME Client for BuyPass |
| CLetsEncryptAcmeServletObject | ACME Client for Let's Encrypt |
| CDiagCallBack | Callback-based diagnostic item that calls a custom function to generate diagnostic content |
| CDiagPtrMon | Monitor and report pointer values |
| CDiagStrMon | Monitor and report string values |
| CDiagVarMon | Monitor and report the value of numeric variables |
| CNB::Wifi::driverStatusStruct | |
| 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 |
| CEBI_CS_cfg_t | Configuration structure for an External Bus Interface (EBI) chip select |
| CEffs_Cfg | Filesystem Configuration |
| CFastIO | Fast GPIO Pin Class |
| CFastIOPortAArray | Accessor class for GPIO Port A: FastPortA[n] returns the FastIO for pin n of Port A |
| CFastIOPortBArray | Accessor class for GPIO Port B: FastPortB[n] returns the FastIO for pin n of Port B |
| CFastIOPortCArray | Accessor class for GPIO Port C: FastPortC[n] returns the FastIO for pin n of Port C |
| CFastIOPortDArray | Accessor class for GPIO Port D: FastPortD[n] returns the FastIO for pin n of Port D |
| CFastIOPortEArray | Accessor class for GPIO Port E: FastPortE[n] returns the FastIO for pin n of Port E |
| CFastIOPortFArray | Accessor class for GPIO Port F: FastPortF[n] returns the FastIO for pin n of Port F |
| CFastIOPortGArray | Accessor class for GPIO Port G: FastPortG[n] returns the FastIO for pin n of Port G |
| CFastIOPortHArray | Accessor class for GPIO Port H: FastPortH[n] returns the FastIO for pin n of Port H |
| CFastIOPortIArray | Accessor class for GPIO Port I: FastPortI[n] returns the FastIO for pin n of Port I |
| CFastIOPortJArray | Accessor class for GPIO Port J: FastPortJ[n] returns the FastIO for pin n of Port J |
| CFastIOPortKArray | Accessor class for GPIO Port K: FastPortK[n] returns the FastIO for pin n of Port K |
| Cfifo_buffer_storage | FIFO buffer storage using linked pool buffers |
| CHtmlPageHandler | Base class for HTTP request handlers that process requests for specific URLs and HTTP methods |
| CCallBackFunctionPageHandler | Implements the HtmlPageHandler class as a function pointer callback for GET requests |
| CHTTP_Request | HTTP Request Structure |
| CIEEE1588Timer | |
| 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 Representation |
| CIPV6_ROOT_EL | Base class for all IPv6 interface elements |
| 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_ROUTER | IPv6 router information element |
| CIPV6_ROOT_EL_CONTAINER | Container for managing collections of IPv6 root elements |
| 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 |
| CJsonRef | Represents a positional reference (pointer) of a location inside a ParsedJsonDataSet object |
| CDHCP::LeaseAllocator | Base class/interface for lease allocators for the DHCP server |
| CDHCP::BlockAllocator | Basic allocator that handles multiple leases in a contiguous IP block |
| CDHCP::MacPrefixAllocator | 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 |
| CDHCP::SingleAllocator | Stripped down allocator Fails to conform to many standard behaviors, but shows the basics of what needs to be implemented |
| Clisten_list_item | Structure to use to create custom lists of listentiing ports and interfaces |
| CMACADR | Used to store and manipulate MAC addresses |
| CmcanMODM7AE70::mcan_config | MCAN configuration structure |
| Cmcan_extended_message_filter_element | MCAN extended message ID filter element structure |
| CmcanMODM7AE70::mcan_module | MCAN Module Class |
| 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 |
| CMQTT::mqtt_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::ConfigExposer | Easy MqttObj class for automatically publishing and subscribing NetBurner Config system objects to/from an MQTT topic. Use like a normal ConfigObj |
| CMQTT::SubHandler | Easy class for registering a callback function that receives messages on an MQTT topic and handles them appropriately. Behaves similarly to HttpResponseHandler |
| CMQTT::mqtt_IO | Easy MqttObj class for automatically publishing and subscribing hardware GPIO pins to/from an MQTT topic. Use like a normal PinIO |
| CMQTT::mqtt_IO_Input | MqttObj connecting hardware GPIO pins to an Mqtt Broker. This class defaults the pin to an Input state |
| CMQTT::mqtt_IO_Output | MqttObj connecting hardware GPIO pins to an Mqtt Broker. This class defaults the pin to an Output state |
| CMQTT::mqtt_bool | Easy MqttObj class for automatically publishing and subscribing boolean values to/from an MQTT topic. Use like a normal bool |
| CMQTT::mqtt_float | Easy MqttObj class for automatically publishing and subscribing floating point values to/from an MQTT topic. Use like a normal double |
| CMQTT::mqtt_int | Easy MqttObj class for automatically publishing and subscribing unsigned integer values to/from an MQTT topic. Use like a normal int32_t |
| CMQTT::mqtt_obj | Base class for easy MQTT Objects (MqttObj). mqtt_obj are comprised of higher order parent objects that contain registered child objects |
| CMQTT::mqtt_string | Easy MqttObj class for automatically publishing and subscribing string values to/from an MQTT topic. Use like a normal NBString |
| CMQTT::mqtt_uint | Easy MqttObj class for automatically publishing and subscribing unsigned integer values to/from an MQTT topic. Use like a normal uint32_t |
| CMQTT::PacketInfo::Msg | PacketInfo::Msg message data structure |
| 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 |
| CNBInterpolatedString | A wrapper for NBString::Interpolate() ideal for easy access to ephemeral values |
| Cncm_ndp16_entry_t | NCM NDP16 Datagram Entry |
| Cncm_ndp16_t | NCM NDP16 - 16-bit NCM Datagram Pointer |
| Cncm_notification_network_t | NCM Network Connection Notification |
| Cncm_notification_speed_t | NCM Connection Speed Change Notification |
| Cncm_ntb_input_size_t | NCM SET_NTB_INPUT_SIZE structure (when 8-byte form is used) |
| Cncm_ntb_parameters_t | NCM NTB Parameters Structure |
| Cncm_nth16_t | NCM NTH16 - 16-bit NCM Transfer Header |
| CNTPServer | |
| CNTPServer::NtpTimeStamp | |
| 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 |
| Cpool_buffer | Main buffer structure for network and serial communication |
| 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 |
| CParsedURI | Parsed Uniform Resource Identifier Class (URI) |
| CPartitionEntry | |
| CPartitionTable | |
| Cfifo_buffer_storage::PeekIterator | Iterator for non-destructive examination of buffered data |
| CPinIO | GPIO Pin Class |
| CPinIOArray2 | |
| CPinIOArrayJ1 | |
| CPinIOJ1Array | |
| CPinIOPortAArray | Accessor class for GPIO Port A: PortA[n] returns the PinIO for pin n of Port A |
| CPinIOPortBArray | Accessor class for GPIO Port B: PortB[n] returns the PinIO for pin n of Port B |
| CPinIOPortCArray | Accessor class for GPIO Port C: PortC[n] returns the PinIO for pin n of Port C |
| CPinIOPortDArray | Accessor class for GPIO Port D: PortD[n] returns the PinIO for pin n of Port D |
| CPinIOPortEArray | Accessor class for GPIO Port E: PortE[n] returns the PinIO for pin n of Port E |
| CPinIOPortFArray | Accessor class for GPIO Port F: PortF[n] returns the PinIO for pin n of Port F |
| CPinIOPortGArray | Accessor class for GPIO Port G: PortG[n] returns the PinIO for pin n of Port G |
| CPinIOPortHArray | Accessor class for GPIO Port H: PortH[n] returns the PinIO for pin n of Port H |
| CPinIOPortIArray | Accessor class for GPIO Port I: PortI[n] returns the PinIO for pin n of Port I |
| CPinIOPortJArray | Accessor class for GPIO Port J: PortJ[n] returns the PinIO for pin n of Port J |
| CPinIOPortKArray | Accessor class for GPIO Port K: PortK[n] returns the PinIO for pin n of Port K |
| CPsudeoHeader | UDP/TCP IPv4 Pseudo-header Structure (bits 0 through 95 of the pseudo-header) |
| CMQTT::PublishRequest | Structure used to specify details for a Publish call |
| CQSPI_Record | This struct contains the major variables/configurations used for a QSPI transfer |
| Cfifo_buffer_storage::ReadBufPtr | RAII accessor for reading from buffer storage |
| CReadLookUpObject | Internal read-side lookup record linking an OID to its dispatcher |
| CSAI_cfg_t | Complete configuration structure for the SAI driver |
| CSAI_rxtx_cfg_t | Configuration structure for one direction (TX or RX) of the SAI module |
| CSAICtx_t | Main driver class for SAI peripheral operation |
| CSEMC_cfg_t | Configuration structure for SEMC (Smart External Memory Controller) interface |
| CSerialConfigServlet | Class to run serial configurator |
| CSerialRecord | |
| CDHCP::Server | DHCP Server class Requires a lease allocator to be added in order to function |
| CSMPoolPtr | Smart pointer wrapper for automatic buffer management |
| CSNMPReadObject | Registers a scalar read callback with the SNMP agent |
| CSnmpServlet | SNMP agent servlet that listens for and processes SNMP requests |
| CSNMPWriteObject | Registers a scalar write callback with the SNMP agent |
| CspiDriverStruct | Variables/configurations for a DSPI transfer |
| CSPIModule | SPI Peripheral Module Class |
| CSPI_QSPI | The Single-Bit SPI mode QSPI Peripheral Class |
| CSPI_USART | USART in SPI mode Peripheral Module Class |
| CSRAM_Timing_Spec_t | Timing specifications for common SRAM speeds |
| 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 | High-resolution stopwatch timer for precise event timing and performance measurement |
| CMQTT::SubscribeFilter | Structure used to specify a topic filter for subscriptions |
| CMQTT::SubscribeFilter_NbStr | Structure used to specify a topic filter for subscriptions |
| CMQTT::SubscribeRequest | Structure used to specify details for a Subscribe call |
| CTEMPL_Q< T > | A convenience wrapper around OS_Q |
| CTFTP_Server | TFTP Server Class |
| CTFTP_Server_source_File | TFTP Server Source File |
| Cusb_throughput_test.ThroughputStats | |
| 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 structure containing complete time zone information |
| CMQTT::TopicHandler | TopicHandler context definition |
| CTwoWire | Arduino Wire-compatible I2C controller/target interface |
| CTwoWireObject | Convenience wrapper binding a TwoWire instance and device address |
| CUDPPacket | UDP Packet Class - Complete UDP packet management |
| CUDPPKT | Internal UDP Packet Header Structure |
| 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 |
| CWatchdogResetCause | |
| CWebConfigServlet | Class to run web configurator |
| CNB::WebSocket | WebSocket connection management class |
| Cwifi_init | |
| CWifiInterface | WiFi Interface clas |
| CWM8904 | |
| Cfifo_buffer_storage::WriteBufPtr | RAII accessor for writing to buffer storage |
| CWriteLookUpObject | Internal write-side lookup record linking an OID to its dispatcher |