Mike Pulice / ublox_C200Test

Fork of SprintUSBModemHTTPClientTest by Donatien Garnier

Embed: (wiki syntax)

« Back to documentation index

Data Structures

Data Structures

Here are the data structures with brief descriptions:
AnalogInAn analog input, used for reading the voltage on a pin
AnalogOutAn analog output, used for setting the voltage on a pin
api_msgThis struct contains a function to execute in another thread context and a struct api_msg_msg that serves as an argument for this function
api_msg_msgThis struct includes everything that is necessary to execute a function for a netconn in another thread context (mainly used to process netconns in the tcpip_thread context to be thread safe)
APSR_TypeUnion type to access the Application Program Status Register (APSR)
ATCommandsInterfaceAT Commands interface class
BusInA digital input bus, used for reading the state of a collection of pins
BusInOutA digital input output bus, used for setting the state of a collection of pins
BusOutA digital output bus, used for setting the state of a collection of pins
CANA can bus client, used for communicating with can devices
CANMessageCANMessage class
CONTROL_TypeUnion type to access the Control Registers (CONTROL)
dhcp_msgMinimum set of fields of any DHCP message
DigitalInA digital input, used for reading the state of a pin
DigitalInOutA digital input/output, used for setting or reading a bi-directional pin
DigitalOutA digital output, used for setting the state of a pin
DirHandleRepresents a directory stream
dns_api_msgAs do_gethostbyname requires more arguments but doesn't require a netconn, it has its own struct (to avoid struct api_msg getting bigger than necessary)
EndpointIP Endpoint (address, port)
eth_hdrEthernet header
eth_vlan_hdrVLAN header inserted between ethernet header and payload if 'type' in ethernet header is ETHTYPE_VLAN
etharp_hdrARP message, see RFC 826 ("Packet format")
etharp_q_entryStruct for queueing outgoing packets for unknown address defined here to be accessed by memp.h
EthernetAn ethernet interface, to use with the ethernet pins
FileHandleAn OO equivalent of the internal FILEHANDLE variable and associated _sys_* functions
FileSystemLikeA filesystem-like object is one that can be used to open files though it by fopen("/name/filename", mode)
FunctionPointerA class for storing and calling a pointer to a static or member void function
HTTPClientA simple HTTP Client The HTTPClient is composed of:

  • The actual client (HTTPClient)
  • Classes that act as a data repository, each of which deriving from the HTTPData class (HTTPText for short text content, HTTPFile for file I/O, HTTPMap for key/value pairs, and HTTPStream for streaming purposes)
HTTPMapMap of key/value pairs Used to transmit POST data using the application/x-www-form-urlencoded encoding
HTTPTextA data endpoint to store text
I2CAn I2C Master, used for communicating with I2C slave devices
I2CSlaveAn I2C Slave, used for communicating with an I2C Master device
IATCommandsProcessorInterface implemented by components executing complex AT commands
IATEventsHandlerInterface implemented by components handling AT events
icmp_echo_hdrThis is the standard ICMP header only that the u32_t data is splitted to two u16_t like ICMP echo needs it
igmp_groupIgmp group structure - there is a list of groups for each interface these should really be linked from the interface, but if we keep them separate we will not affect the lwip original code too much
IHTTPDataInThis is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...)
IHTTPDataOutThis is a simple interface for HTTP data storage (impl examples are Key/Value Pairs, File, etc...)
in_addrFor compatibility with BSD code
InterruptInA digital interrupt input, used to call a function on a rising or falling edge
InterruptManagerUse this singleton if you need to chain interrupt handlers
IPInterfaceGeneric IP-based network interface
IPSR_TypeUnion type to access the Interrupt Program Status Register (IPSR)
IUSBHostSerialGeneric interface to abstract 3G dongles' impl
local_hostlist_entryStruct used for local host-list
LocalFileSystemA filesystem for accessing the local mbed Microcontroller USB disk drive
LwIPInterfaceLwIP-based network interface
Mail< T, queue_sz >The Mail class allow to control, send, receive, or wait for mail
MemoryPool< T, pool_sz >Define and manage fixed-size memory pools of objects of a given type
memp_malloc_helperThis structure is used to save the pool one element came from
mib_array_nodeDerived node, points to a fixed size const array of sub-identifiers plus a 'child' pointer
mib_external_nodeDerived node, has access functions for mib object in external memory or device using 'tree_level' and 'idx', with a range 0
mib_list_rootnodeDerived node, points to a doubly linked list of sub-identifiers plus a 'child' pointer
mib_nodeNode "base class" layout, the mandatory fields for a node
mib_ram_array_nodeDerived node, points to a fixed size mem_malloced array of sub-identifiers plus a 'child' pointer
MutexUsed to synchronise the execution of threads
netconnA netconn descriptor
netifGeneric data structure used for all lwIP network interfaces
NVIC_TypeStructure type to access the Nested Vectored Interrupt Controller (NVIC)
obj_defObject definition returned by (get_object_def)()
os_mailQ_defDefinition structure for mail queue
os_messageQ_defDefinition structure for message queue
os_mutex_defMutex Definition structure contains setup information for a mutex
os_pool_defDefinition structure for memory block allocation
os_semaphore_defSemaphore Definition structure contains setup information for a semaphore
os_thread_defThread Definition structure contains startup information of a thread
os_timer_defTimer Definition structure contains timer parameters
osEventEvent structure contains detailed information about an event
pbuf_customA custom pbuf: like a pbuf, but following a function pointer to free it
pbuf_custom_refA custom pbuf that holds a reference to another pbuf, which is freed when this custom pbuf is freed
PortInA multiple pin digital input
PortInOutA multiple pin digital in/out used to set/read multiple bi-directional pins
PortOutA multiple pin digital out
PPPIPInterfaceInterface using PPP to connect to an IP-based network
PwmOutA pulse-width modulation digital output
Queue< T, queue_sz >The Queue class allow to control, send, receive, or wait for messages
RtosTimerAllow creating and and controlling of timer functions in the system
SCB_TypeStructure type to access the System Control Block (SCB)
SemaphoreUsed to manage and protect access to a set of shared resources
SerialA serial port (UART) for communication with other serial devices
SMSInterfaceComponent to use the Short Messages Service (SMS)
snmp_obj_idInternal object identifier representation
snmp_resp_header_lengthsOutput response message header length fields
snmp_trap_header_lengthsOutput response message header length fields
SocketSocket file descriptor and select wrapper
SPIA SPI Master, used for communicating with SPI slave devices
SPISlaveA SPI slave, used for communicating with a SPI Master device
SprintUSBModemSprint USB Modem (Sierra Wireless 598U)
SysTick_TypeStructure type to access the System Timer (SysTick)
TCPSocketConnectionTCP socket connection
TCPSocketServerTCP Server
ThreadAllow defining, creating, and controlling thread functions in the system
TickerA Ticker is used to call a function at a recurring interval
TimeIntervalTime interval class used to specify timeouts
TimeoutA Timeout is used to call a function at a point in the future
TimerA general purpose timer
TimerEventBase abstraction for timer interrupts
UDPSocketUDP Socket
WANDongleA class to use a WAN (3G/LTE) access dongle
WANDongleSerialPortA class to use a WAN (3G/LTE) access dongle
WebsocketWebsocket client Class
xPSR_TypeUnion type to access the Special-Purpose Program Status Registers (xPSR)