@CHIP-RTOS C Library - TCP/IP API

Header File:         #include <TCPIP.H>
                    which includes <TCPIPAPI.H>

This API provides access to the IPC@CHIP® TCP/IP stack's socket interface for programming TCP/IP applications.

Please note, that we cannot explain the entire functionality of the TCP/IP protocol and the working of the socket interface in this document.   Good books for understanding TCP/IP and the socket interface are:

1. Internetworking with TCP/IP, Volume 1-3 from Douglas E.Comer
2. TCP/IP Illustrated, Volume 1 from W. Richard Stevens

Related :

• TCP/IP Data Structures
  
• TCP/IP Error Codes Listing
  
• Device Driver API   (For user defined TCP/IP devices)
  
• Cryptographic API
  
• IP Security API
  
• BSD compatible alternative socket API
  
• TCP/IP IPv4/v6 Dual layer stack
  
• Client/Server applications
  

TCP/IP Functions

Get_IPConfig	Get IP, subnet mask and/or gateway
Set_IPConfig	Set IP, subnet mask and/or gateway
PPP_Server_GetIP	Get IP Address of the PPP Server
PPP_Client_GetIP	Get IP Address of the PPP Client
InetToAscii	Convert an IPv4 address to an IP string
inet_addr	Converts a string containing an IPv4 address in dot notation
inet_pton	Convert an IP address (IPv4 or IPv6) from standard text representation to binary
inet_ntop	Convert an IP address (IPv4 or IPv6) from binary to standard text representation
--- Socket Functions --- opensocket	Open TCP or UDP IPv4 socket
opensocket_ext	Open an IPv4 or IPv6 socket
closesocket	Close socket
bind	Associates a local address with a socket
connect	Establish a connection to a specifed socket
GetWaitingBytes	Report the number of bytes on a socket
Set_IP_Type_Of_Service	Set socket's Type-Of-Service
setsockopt	Set options on a socket
getsockopt	Get options on a socket
Set_Blocking_Mode	Set a socket in blocking or non-blocking mode
get_socketerror	Get last socket error
select	Await events on a selected set of sockets
--- TCP/IP Sockets --- tcp_connect	Open TCP/IP socket and connect
accept	Accept the next incoming connection
listen	Listen for incoming connections
htons	Converts a 16 bit word from host to TCP/IP network byte order
htonl	Converts a 32 bit long word from host to TCP/IP network byte order
send	Transmit a message (TCP)
recv	Receive message (TCP)
ResetConnection	Abort a connection on a socket
setlinger	Set linger time on close (TCP)
setreuse	Set reuse option on a listening socket
Get_TCP_Socket_State	Find TCP socket and return state
Get_TCP_Socket_State_IP_All	Find TCP socket and return state (IPv4 and IPv6)
FindAllOpenSockets	Get information about all open sockets
FindAllOpenSockets_IP_All	Get information about all open sockets (IPv4 and IPv6)
shutdown	Shutdown socket in read,write or both directions
--- UDP Sockets --- recvfrom	Receive a datagram and store the source address
recvfromto	Receive a datagram and store source and dest. address
sendto	Transmit a datagram
sendto_iface	Transmit a datagram via specified device
--- DNS Resolver --- getHostByName	Get a host's address(es) by domain name (IPv4)
getHostByName2	Get a host's address(es) by domain name (IPv6)
getHostByAddr	Get a host's domain name by address (IPv4)
getHostByAddr2	Get a host's domain name by address (IPv6)
getMailHosts	Get mail hosts
setNameServer	Add prioritised name server

PKI/SSL Functions

--- PKI Functions --- PKI_CertificateAdd	Add a certificate to the PKI
PKI_CertificateDel	Delete a certificate from the PKI
PKI_OwnKeyPairAdd	Add own private/public key pair
--- SSL Functions --- SSL_SessionNew	Open a new SSL session
SSL_SessionClose	Close a SSL session
SSL_SessionProp	Set SSL session proposals
SSL_SessionOpt	Set SSL session options
SSL_AddClientCA	Add a client CA certificate
SSL_ClientStart	Start the SSL client
SSL_SendFlush	Flush SSL user data
SSL_ConnClose	Close a SSL connection
SSL_Get_ConnState	Get SSL connection state information
SSL_HandshakeComplete	Check handshake status

PPP Client Functions

PPP_Client_Installed	Check if PPP client is installed
PPP_Client_Open	Open a PPP connection (IPv4)
PPP_Client_Open_IPv6	Open a PPP connection with IPv6 address config
PPP_Client_Close	Close a PPP client connection
PPP_Client_GetStatus	Get PPP client status
PPP_Client_Get_DNSIP	Get DNS IP
PPP_Client_SetOptions	Set PPP options for the PPP client
PPP_Client_GetIP	Get IP Address of the PPP Client
PPP_Client_Pause	Pause/resume the PPP client task

PPP Server Functions

PPP_Server_Installed	Check if PPP server is installed
PPP_Server_Suspend	Suspend the PPP server task
PPP_Server_Activate	Activate the PPP server
PPP_Server_GetStatus	Get the current state of the PPP server
PPP_Server_Get_Cfg	Get configuration data of the IPv4 PPP server
PPP_Server_Get_Cfg_IPv6	Get configuration data of the IPv6 PPP server
PPP_Server_SetOptions	Set PPP options for the PPP server
PPP_Server_GetIP	Get IP Address of the PPP Server
PPP_Server_Pause	Pause/resume the PPP server task

Other Functions

--- Monitoring --- Get_FTP_Login_Counters	Access the FTP server login counters
Get_Telnet_Login_Counters	Access the Telnet server login counters
Get_Telnet_State	Check if have an active telnet session
Get_Installed_Servers	Get information about running servers
Get_TCPIP_Memory_Status	Get information about TCP/IP stack memory usage
Get_TCPIP_Statistics	Access the internal network packet counter
Get_SNMP_Data	Get internal TCP/IP SNMP variables
Get_SNMP_DataEx	Get internal TCP/IP SNMP variables (Extended)
--- DHCP --- DHCP_use	Set/Reset DHCP usage of the Ethernet interface
Get_DHCP_Status	Get DHCP status of the Ethernet interface
Get_DHCP_Status_Ext	Get DHCP status of the Ethernet interface
--- ping --- Ping_Open	Open and start ICMP echo requests
Ping_Close	Finish ICMP echo requests
Ping_Statistics	Retrieve ping information
--- Server Time-outs --- Set_FTPServer_Idle_Timeout	Set FTP server time-out
Set_TelnetServer_Idle_Timeout	Set Telnet server time-out
Get_FTPServer_Idle_Timeout	Get FTP server time-out value
Get_TelnetServer_Idle_Timeout	Get Telnet server time-out value
--- Gateway --- AddDefaultGateway	Deprecated! Add the default gateway
AddDefaultGatewayEx	Add the default gateway (Extended)
DelDefaultGateway	Delete the default gateway
GetDefaultGateway	Get the current default gateway
AddStaticRoute	Add a route for an interface
AddStaticRouteEx	Add a route for an interface (extended)
DelStaticRoute	Delete a route from an interface
--- ARP cache access --- DelArpEntryByPhys	Delete ARP entry by physical address
AddArpEntry	Add an entry in the ARP table
GetARPRouteCacheEntries	Read ARP cache table
--- IP Multicast --- Add_IGMP_Membership	Install an IP multicast address entry
Drop_IGMP_Membership	Delete an IP multicast address entry
IPMulticast_to_MacAddr	Map IP multicast address to Ethernet address
--- Callback Installers --- RegisterCallbackFunction	Register a user TCP callback function
RegisterIPCallbackHandler	Register an User callback handler for incoming IP packets
RegisterIPCallbackHandler_Snd	Register an User callback handler for outgoing IP packets
Register_ARP_User_CB	Register an ARP User callback handler.
--- Miscellaneous --- api_sleep	Deprecated! Sleep for specified number of milliseconds
Reconfigure_ethernet	Reconfigure Ethernet interface
Get_Iface_Entries	Deprecated! Read table of TCP/IP device interfaces
Get_Iface_Entries_Ext	Read table of TCP/IP device interfaces with all IPv4 configurations/per interface
SetIfaceMTU	Set MTU of an device interface
Get_IPv6_Iface_Entries	TCP/IP IPv6 device interface information

List of C Libraries
@CHIP-RTOS Main Index