Function Overview

The following list provides a brief overview of all Network Component functions.

HTTP Server

Control Interface

• netHTTPs_GetClient — Get IP address and port number of a connected remote HTTP client. [thread-safe].
• netHTTPs_GetContentType — Get Content-Type HTML header, received in XML post request. [thread-safe].
• netHTTPs_GetLanguage — Retrieve the preferred language setting from the browser. [thread-safe].
• netHTTPs_GetPassword — Retrieve password of the built-in user account. [thread-safe].
• netHTTPs_GetPort — Get port number of the HTTP server. [thread-safe].
• netHTTPs_GetRootPath — Retrieve path to the root directory on HTTP server. [thread-safe].
  
• netHTTPs_GetSession — Get current session number of the HTTP server. [thread-safe].
• netHTTPs_GetUsername — Retrieve username of the built-in user account. [thread-safe].
• netHTTPs_LoginActive — Determine if the HTTP server authentication is enabled. [thread-safe].
• netHTTPs_LoginOnOff — Enable or disable HTTP server authentication. [thread-safe].
• netHTTPs_Running — Check if the HTTP server is running. [thread-safe].
• netHTTPs_SetPassword — Reset password of the built-in user account. [thread-safe].
• netHTTPs_SetPort — Set port number of the HTTP server. [thread-safe].
• netHTTPs_SetRootPath — Set path to the root directory on HTTP server. [thread-safe].
• netHTTPs_SetUsername — Set username of the built-in user account. [thread-safe].
• netHTTPs_Start — Start the HTTP server. [thread-safe].
• netHTTPs_Stop — Stop the HTTP server. [thread-safe].

Access and Multi-User Interface

• netHTTPs_AcceptClient — Accept or deny a connection from a remote HTTP client. [user-provided].
• netHTTPs_CheckAccount — Check if an user account exist in the user database. [user-provided].
• netHTTPs_GetUserSecret — Retrieve the secret word for the selected user. [user-provided].
  
• netHTTPs_FileAccess — Check if remote user is allowed to access a file on HTTP server. [user-provided].
• netHTTPs_GetUserId — Retrieve the user identification. [thread-safe].
• netHTTPs_CalcHashHA1 — Calculate HA1 hash value for the given credentials. [thread-safe].

File System Interface

• netHTTPs_fclose — Close a file previously open on HTTP server. [interface].
• netHTTPs_fgets — Read a string from a file on HTTP server. [interface].
• netHTTPs_fopen — Open a file for reading on HTTP server. [interface].
• netHTTPs_fread — Read block of data from a file on HTTP server. [interface].
• netHTTPs_fstat — Retrieve file size and last modification time. [interface].

Common Gateway Interface (CGI)

• netCGI_Charset — Override default character encoding in HTML documents. [user-provided].
• netCGI_ContentType — Add custom MIME type for unsupported file types. [user-provided].
• netCGI_CustomHeader — Add custom HTTP response header. [user-provided].
• netCGI_GetEnvVar — Process environment variables and convert to ANSI format. [thread-safe].
• netCGI_ProcessCookie — Process HTTP cookie. [user-provided].
• netCGI_ProcessData — Process data received by POST request. [user-provided].
• netCGI_ProcessQuery — Process query string received by GET or POST request. [user-provided].
• netCGI_ProcessRequest — Process HTTP request. [user-provided].
• netCGI_Redirect — Redirect resource URL address to a new location. [user-provided].
• netCGI_Script — Generate dynamic web data based on a CGI script. [user-provided].
• netCGI_SetCookie — Set HTTP cookie to send to the client. [thread-safe].
• netCGX_ContentType — Override default Content-Type for CGX script files. [user-provided].

FTP Server

Control Interface

• netFTPs_GetPassword — Retrieve password of the built-in user account. [thread-safe].
• netFTPs_GetPort — Get port number of FTP server. [thread-safe].
• netFTPs_GetRootPath — Retrieve path to the root directory on FTP server. [thread-safe].
• netFTPs_GetUsername — Retrieve username of the built-in user account. [thread-safe].
• netFTPs_LoginActive — Determine if FTP server authentication is enabled. [thread-safe].
• netFTPs_LoginOnOff — Enable or disable FTP server authentication. [thread-safe].
• netFTPs_Running — Check if FTP server is running. [thread-safe].
• netFTPs_SetPassword — Reset password of the built-in user account. [thread-safe].
• netFTPs_SetPort — Set port number of FTP server. [thread-safe].
• netFTPs_SetRootPath — Set path to the root directory on FTP server. [thread-safe].
• netFTPs_SetUsername — Set username of the built-in user account. [thread-safe].
• netFTPs_Start — Start FTP server. [thread-safe].
• netFTPs_Stop — Stop FTP server. [thread-safe].

Access and Multi-User Interface

• netFTPs_AcceptClient — Accept or deny connection from remote FTP client. [user-provided].
• netFTPs_CheckPassword — Check user account password in the user database. [user-provided].
• netFTPs_CheckUsername — Check if an user account exists in the user database. [user-provided].
• netFTPs_FileAccess — Check if remote user is allowed to access a file on FTP server. [user-provided].
• netFTPs_GetUserId — Retrieve the user identification number. [thread-safe].

User Callback

• netFTPs_Notify — Notify the user application about events in FTP server service. [user-provided].

File System Interface

• netFTPs_fclose — Close a file previously open on FTP server. [interface].
• netFTPs_fdelete — Delete a file on FTP server. [interface].
• netFTPs_ffind — Search the file system directory for matching files. [interface].
• netFTPs_fopen — Open a file for reading or writing on FTP server. [interface].
• netFTPs_fread — Read block of data from a file on FTP server. [interface].
• netFTPs_frename — Rename a file or directory on FTP server. [interface].
• netFTPs_fwrite — Write block of data to a file on FTP server. [interface].
• netFTPs_mkdir — Make a new directory on FTP server. [interface].
• netFTPs_rmdir — Remove an empty directory on FTP server. [interface].
• netFTPs_chdir — Check that the directory exists on FTP server. [interface].

FTP Client

Control Interface

• netFTPc_Connect — Start FTP client file operation session. [thread-safe].

User Callbacks

• netFTPc_Notify — Notify the user application when FTP client operation ends. [user-provided].
• netFTPc_Process — Request parameters for FTP client session. [user-provided].

File System Interface

• netFTPc_fclose — Close local file previously open in FTP client. [interface].
• netFTPc_fopen — Open local file for reading or writing in FTP client. [interface].
• netFTPc_fread — Read block of data from local file in FTP client. [interface].
• netFTPc_fwrite — Write block of data to local file in FTP client. [interface].

TFTP Server

Control Interface

• netTFTPs_GetPort — Get port number of the TFTP server. [thread-safe].
• netTFTPs_GetRootPath — Retrieve path to the root directory on TFTP server. [thread-safe].
• netTFTPs_Running — Check if the TFTP server is running. [thread-safe].
• netTFTPs_SetPort — Set port number of the TFTP server. [thread-safe].
• netTFTPs_SetRootPath — Set path to the root directory on TFTP server. [thread-safe].
• netTFTPs_Start — Start the TFTP server. [thread-safe].
• netTFTPs_Stop — Stop the TFTP server. [thread-safe].

Access Interface

• netTFTPs_AcceptClient — Accept or deny connection from a remote TFTP client. [user-provided].

File System Interface

• netTFTPs_fclose — Close a file previously open on the TFTP server. [interface].
• netTFTPs_fopen — Open a file for reading or writing on the TFTP server. [interface].
• netTFTPs_fread — Read block of data from a file on the TFTP server. [interface].
• netTFTPs_fwrite — Write block of data to a file on the TFTP server. [interface].

TFTP Client

Control Interface

• netTFTPc_Get — Retrieve a file from a remote TFTP server. [thread-safe].
• netTFTPc_Put — Put a file to a remote TFTP server. [thread-safe].

User Callback

• netTFTPc_Notify — Notify the user application when TFTP client operation ends. [user-provided].

File System Interface

• netTFTPc_fclose — Close local file previously open in the TFTP client. [interface].
• netTFTPc_fopen — Open local file for reading or writing in the TFTP client. [interface].
• netTFTPc_fread — Read block of data from local file in the TFTP client. [interface].
• netTFTPc_fwrite — Write block of data to local file in the TFTP client. [interface].

Telnet Server

Control Interface

• netTELNETs_CheckCommand — Check command string for a command. [thread-safe].
• netTELNETs_GetClient — Get IP address and port number of a connected Telnet client. [thread-safe].
• netTELNETs_GetPassword — Retrieve password of the built-in user account. [thread-safe].
• netTELNETs_GetPort — Get port number of the Telnet server. [thread-safe].
• netTELNETs_GetSession — Get current session number of the Telnet server. [thread-safe].
• netTELNETs_GetUsername — Retrieve username of the built-in user account. [thread-safe].
• netTELNETs_LoginActive — Determine if Telnet server authentication is enabled. [thread-safe].
• netTELNETs_LoginOnOff — Enable or disable Telnet server authentication. [thread-safe].
• netTELNETs_RepeatCommand — Request a repeated call to netTELNETs_ProcessCommand function. [thread-safe].
• netTELNETs_RequestMessage — Request unsolicited message processing in netTELNETs_ProcessMessage function. [thread-safe].
• netTELNETs_Running — Check if the Telnet server is running. [thread-safe].
• netTELNETs_SetPassword — Reset password of the built-in user account. [thread-safe].
• netTELNETs_SetPort — Set port number of the Telnet server. [thread-safe].
• netTELNETs_SetUsername — Set username of the built-in user account. [thread-safe].
• netTELNETs_Start — Start the Telnet server. [thread-safe].
• netTELNETs_Stop — Stop the Telnet server. [thread-safe].

Access and Multi-User Interface

• netTELNETs_AcceptClient — Accept or deny a connection from a remote Telnet client. [user-provided].
• netTELNETs_CheckPassword — Check user account password in the user database. [user-provided].
• netTELNETs_CheckUsername — Check if an user account exist in the user database. [user-provided].
• netTELNETs_GetUserId — Retrieve the user identification number. [thread-safe].

User Callbacks

• netTELNETs_ProcessCommand — Process and execute a command requested by the Telnet client. [user-provided].
• netTELNETs_ProcessMessage — Request a message for a Telnet server session. [user-provided].

SNMP Agent

Control Interface

• netSNMP_SetCommunity — Change SNMP community to a new community. [thread-safe].
• netSNMP_SetMIB_Table — Register MIB table to SNMP Agent. [thread-safe].
• netSNMP_Trap — Send a trap message to the Trap Manager. [thread-safe].

DNS Client

Control Interface

• netDNSc_cb_t — DNS Client Event callback function.
• netDNSc_GetHostByName — Resolve IP address of a host from a hostname. [thread-safe].
• netDNSc_GetHostByNameX — Resolve IP address of a host from a hostname in blocking mode. [thread-safe].
• netDNSc_ClearCache — Flush or clear the local DNS cache. [thread-safe].

SNTP Client

Control Interface

• netSNTPc_cb_t — SNTP Client callback function.
• netSNTPc_GetTime — Determine current time from NTP or SNTP time server. [thread-safe].
• netSNTPc_GetTimeX — Determine current time from NTP or SNTP time server in blocking mode. [thread-safe].
• netSNTPc_SetMode — Set mode of operation for SNTP client. [thread-safe].

SMTP Client

Control Interface

• netSMTPc_Connect — Start SMTP client to send an email in legacy mode. [thread-safe].
• netSMTPc_SendMail — Send an email in blocking mode. [thread-safe].

User Callbacks

• netSMTPc_AcceptAuthentication — Accept or deny authentication requested by SMTP server. [user-provided].
• netSMTPc_Notify — Notify the user application when SMTP client operation ends. [user-provided].
• netSMTPc_Process — Request parameters for SMTP client session. [user-provided].

File System Interface

• netSMTPc_fclose — Close a file previously open in SMTP client. [interface].
• netSMTPc_fopen — Open a file for reading in SMTP client. [interface].
• netSMTPc_fread — Read block of data from a file in SMTP client. [interface].

Ping Client

Ping Client

• netPing_cb_t — Ping Event callback function.
• netPing_Echo — Start ICMP ping process. [thread-safe].
• netPing_EchoX — Start ICMP ping process in blocking mode. [thread-safe].

Sockets

BSD Socket

• accept — Accept connect request for a listening socket. [thread-safe].
• bind — Assign a local address and port to a socket. [thread-safe].
• closesocket — Close socket and release socket descriptor. [thread-safe].
• connect — Connect a socket to a remote host. [thread-safe].
• gethostbyname — Retrieve host IP address from host name. [thread-safe].
• getpeername — Retrieve IP address and port number of the endpoint node. [thread-safe].
• getsockname — Retrieve local IP address and port number. [thread-safe].
• getsockopt — Retrieve options for the socket. [thread-safe].
• ioctlsocket — Control IO mode of a socket. [thread-safe].
• listen — Set a socket in a listening mode. [thread-safe].
• recv — Receive data on already connected socket. [thread-safe].
• recvfrom — Receive data from endpoint node. [thread-safe].
• recvmsg — Receive a message from a socket. [thread-safe].
• select — Check the status of one or more sockets. [thread-safe].
• send — Send data on already connected socket. [thread-safe].
• sendto — Send data to endpoint node. [thread-safe].
• sendmsg — Send a message to endpoint node. [thread-safe].
• setsockopt — Manipulate options for the socket. [thread-safe].
• socket — Create a communication endpoint called socket. [thread-safe].
• inet_addr — Convert from text address to a network address. [thread-safe].
• inet_aton — Convert from text address to a network address. [thread-safe].
• inet_ntoa — Convert from network address to a text string. [not_thread-safe].
• inet_pton — Convert from text address to a binary network address. [thread-safe].
• inet_ntop — Convert from binary network address to a text string. [thread-safe].

TCP Socket

• netTCP_cb_t — TCP Event callback function.
• netTCP_Abort — Instantly stop TCP communication. [thread-safe].
• netTCP_Close — Stop TCP communication and start closing procedure. [thread-safe].
• netTCP_Connect — Initiate a TCP connection to a remote node. [thread-safe].
• netTCP_GetBuffer — Allocate memory for TCP send buffer. [thread-safe].
• netTCP_GetLocalPort — Retrieve local port number of TCP socket. [thread-safe].
• netTCP_GetMaxSegmentSize — Determine maximum number of data bytes that can be sent in TCP packet. [thread-safe].
• netTCP_GetPeer — Retrieve IP address and port number of remote peer. [thread-safe].
• netTCP_GetSocket — Allocate a free TCP socket. [thread-safe].
• netTCP_GetState — Determine current state of a TCP socket. [thread-safe].
• netTCP_GetTimer — Determine TCP socket connection timeout. [thread-safe].
• netTCP_Listen — Open TCP socket for incoming connection. [thread-safe].
• netTCP_ReleaseSocket — Release TCP socket and free resources. [thread-safe].
• netTCP_ResetReceiveWindow — Reset TCP window size to a default value from the configuration. [thread-safe].
• netTCP_Send — Send a data packet to remote node. [thread-safe].
• netTCP_SendReady — Check if TCP socket can send data. [thread-safe].
• netTCP_SetOption — Set TCP socket IP option. [thread-safe].

UDP Socket

• netUDP_cb_t — UDP Event callback function.
• netUDP_Close — Stop UDP communication and close socket. [thread-safe].
• netUDP_GetBuffer — Allocate memory for UDP send buffer. [thread-safe].
• netUDP_GetLocalPort — Retrieve local port number of UDP socket. [thread-safe].
• netUDP_GetSocket — Allocate a free UDP socket. [thread-safe].
• netUDP_Open — Open UDP socket for communication. [thread-safe].
• netUDP_ReleaseSocket — Release UDP socket and free resources. [thread-safe].
• netUDP_Send — Send data to a remote node. [thread-safe].
• netUDP_SetOption — Set UDP socket IP option. [thread-safe].

Interfaces

Common Interface

• netIF_GetOption — Get the current value of an Interface option. [thread-safe].
• netIF_SetOption — Set the value of an Interface option. [thread-safe].
• netIF_SetDefault — Set default network interface for Internet access. [thread-safe].
  
• netARP_cb_t — ARP Probe Event callback function.
• netARP_CacheIP — Determine whether the ARP table has MAC address resolved for requested IP address. [thread-safe].
• netARP_CacheMAC — Determine whether the ARP table has IP address resolved for requested MAC address. [thread-safe].
• netARP_GetIP — Get IP address from the ARP cache. [thread-safe].
• netARP_GetMAC — Get MAC address from the ARP cache. [thread-safe].
• netARP_Probe — Determine whether the IP address is already in use. [thread-safe].
• netARP_ProbeX — Determine whether the IP address is already in use in blocking mode. [thread-safe].
• netARP_ClearCache — Flush or clear the local ARP cache. [thread-safe].
• netDHCP_Disable — Disable Dynamic Host Configuration at runtime. [thread-safe].
• netDHCP_Enable — Enable Dynamic Host Configuration at runtime. [thread-safe].
• netICMP_SetNoEcho — Enable or disable ICMP Echo response. [thread-safe].
• netIGMP_Join — Join this host to a host group specified with IP address. [thread-safe].
• netIGMP_Leave — Leave a host group specified with IP address. [thread-safe].
• netNBNS_Resolve — Resolve IP address of a host from a NetBIOS hostname. [thread-safe].
• netNBNS_ClearCache — Flush or clear the local NBNS cache. [thread-safe].
• netNDP_cb_t — NDP Probe Event callback function.
• netNDP_CacheIP — Determine whether neighbor cache has MAC address resolved for requested IP address. [thread-safe].
• netNDP_GetIP — Get IP address from neighbor discovery cache. [thread-safe].
• netNDP_GetMAC — Get MAC address from neighbor discovery cache. [thread-safe].
• netNDP_Probe — Determine whether the IP address is already in use. [thread-safe].
• netNDP_ProbeX — Determine whether the IP address is already in use in blocking mode. [thread-safe].
• netNDP_ClearCache — Flush or clear the local NDP cache. [thread-safe].
• netDHCP6_Disable — Disable Dynamic Host Configuration version 6 at runtime. [thread-safe].
• netDHCP6_Enable — Enable Dynamic Host Configuration version 6 at runtime. [thread-safe].
• netICMP6_SetNoEcho — Enable or disable ICMPv6 Echo response. [thread-safe].

Ethernet Interface

• netETH_Notify — Notify the user of Ethernet link state change event. [user-provided].
• netETH_SendRaw — Send raw Ethernet data. [thread-safe].
• netETH_ReceiveRaw — Receive raw Ethernet data. [user-provided].

WiFi Interface

• netWiFi_Scan — Search for available WiFi networks. [thread-safe].
• netWiFi_GetOption — Get the value of the WiFi driver option. [thread-safe].
• netWiFi_SetOption — Set the value of the WiFi driver option. [thread-safe].
• netWiFi_Activate — Activate the WiFi interface. [thread-safe].
• netWiFi_Deactivate — Deactivate the WiFi interface. [thread-safe].
• netWiFi_IsConnected — Get the connection state of the WiFi interface. [thread-safe].
• netWiFi_GetNetInfo — Get the network information of the WiFi interface. [thread-safe].

PPP Interface

• netPPP_Close — Disconnect PPP link between two modems. [thread-safe].
• netPPP_Connect — Start a dial-up connection to remote PPP server. [thread-safe].
• netPPP_LinkUp — Determine the state of PPP link. [thread-safe].
• netPPP_Listen — Start PPP interface to accept incoming PPP connection. [thread-safe].

SLIP Interface

• netSLIP_Close — Disconnect SLIP link between two modems. [thread-safe].
• netSLIP_Connect — Start a dial-up connection to remote SLIP server. [thread-safe].
• netSLIP_LinkUp — Determine the state of SLIP link. [thread-safe].
• netSLIP_Listen — Start SLIP interface to accept incoming SLIP connections. [thread-safe].

IP Address

Conversion Functions

• netIP_aton — Convert IP address from text to binary form. [thread-safe].
• netIP_ntoa — Convert IP address from binary to text form. [thread-safe].
• netMAC_aton — Convert MAC address from text to binary form. [thread-safe].
• netMAC_ntoa — Convert MAC address from binary to text form. [thread-safe].

System Functions (User)

System Functions (User)

• netInitialize — Initialize Network Component and interfaces. [not_thread-safe].
• netUninitialize — De-initialize Network Component and interfaces. [not_thread-safe].
• netSYS_GetHostName — Retrieve localhost name. [thread-safe].
• netSYS_SetHostName — Set localhost name. [thread-safe].

Modem Driver Functions

Modem Driver Functions

• Modem_Dial — Start dialing target number.
• Modem_Hangup — Hangup the line.
• Modem_Initialize — Initialize Modem Device.
• Modem_IsOnline — Check if modem is online.
• Modem_Listen — Start Modem Device listening mode.
• Modem_Notify — Notify the Modem Driver of completion event.
• Modem_Request — Request Callback function for the driver.
• Modem_Uninitialize — De-initialize Modem Device.