Network Component Function Overview. More...

Content
	Directories and Files
	Folders and files related to the Network Component.

	Implemented RFCs
	List of RFCs that are covered by the Network Component.

Description

Network Component Function Overview.

This reference section is divided into the following subsections:

The Network Component implements API functions for the various Services, Sockets, and Interfaces as described in the overview.
IP Address functions allow IP address conversion and describes the related data format.
System Functions (User) initialize the Network Component and allow for hostname management.
Status and Error Codes are described that are returned by the API functions.
Modem Driver Functions implement the interface to an on-chip or external Modem for PPP and SLIP networking.

Function Categories

Each API function of the Network Component indicates a category:

[thread-safe] functions can be called from different threads without any harm. They are either re-entrant or internally protected from re-entering. Internal protection is usually achieved using RTOS mutexes.

[not_thread-safe] functions cannot be used from different threads. It is allowed to be used from the same thread, in which the Network Core super-loop is running.

[user-provided] functions need to be provided by the programmer. Some of user-provided functions are optional, others are mandatory. If an optional function is not provided, a default function from the Network library is used. Mandatory user-provided functions do not exist in the Network library. They have to be provided by the user if required in the application.

[interface] functions are connecting to a different Middleware component (for example the File System). All interface functions are tagged as weak, so they can be replaced with an application specific implementation if required (for example if a different file system is to be used). Usually, the default functions are sufficient for proper operation.