Network Framework

Network-related classes and types, including WiFi adapter management, connection management, data transmission and network protocols. More...

Collaboration diagram for Network Framework:

Data Structures
class	MQTT
	An MQTT client. More...
protocol	<MQTTDelegate>
	Protocol for receiving MQTT events. More...
protocol	<NetworkTimeDelegate>
	Protocol for receiving network time update events. More...
class	NXNetworkTime
	A class for managing network time synchronization. More...
class	NXWireless
	A class for managing wireless connections. More...
class	NXWirelessNetwork
	A class for representing a wireless network. More...
protocol	<WirelessDelegate>
	Protocol for receiving wireless scan events. More...

Enumerations
enum	NXWirelessError { NXWirelessErrorBadAuth, NXWirelessErrorNotFound = (1 << 1), NXWirelessErrorGeneral = (1 << 2) }
	Wireless connection error codes. More...

Functions
void	net_poll (void)
	Occasional polling function for the network system. More...

Detailed Description

Network-related classes and types, including WiFi adapter management, connection management, data transmission and network protocols.

Enumeration Type Documentation

NXWirelessError

enum NXWirelessError

Wireless connection error codes.

Enumerator
NXWirelessErrorBadAuth	Authentication failed (bad credentials)
NXWirelessErrorNotFound	Target network not found.
NXWirelessErrorGeneral	General or unspecified error.

Examples:

examples/Network/ntp/main.m.

Definition at line 16 of file NXWirelessError.h.

             {
  NXWirelessErrorBadAuth =
      (1 << 0), 
  NXWirelessErrorNotFound = (1 << 1), 
  NXWirelessErrorGeneral = (1 << 2),  
} NXWirelessError;

Function Documentation

net_poll()

void net_poll

(

void

)

Occasional polling function for the network system.

This function should be called periodically to allow the network system to perform any necessary background tasks.

Examples:

examples/runtime/ntp/main.c.