www.beck-ipc.com

@CHIP-RTOS C Library V2.00 - TCP/IP API


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

    TCP/IP     PPP Client     PPP Server     Other    

TCP/IP Functions

Get_IPConfigGet IP, subnet mask and/or gateway
Set_IPConfigSet IP, subnet mask and/or gateway
PPP_Server_GetIPGet IP Address of the PPP Server
PPP_Client_GetIPGet IP Address of the PPP Client
InetToAsciiConvert an IP address to an IP string
inet_addrConverts a string containing an IP address to dot notation

        --- Socket Functions ---
opensocketOpen TCP or UDP socket
closesocketClose socket
bindAssociates a local address with a socket
connectEstablish a connection to a specifed socket
GetWaitingBytesReport the number of bytes on a socket
Set_IP_Type_Of_ServiceSet socket's Type-Of-Service
setsockoptSet options on a socket
getsockoptGet options on a socket
Set_Blocking_ModeSet a socket in blocking or non-blocking mode
RegisterCallbackFunctionRegister a user callback function
get_socketerrorGet last socket error

        --- TCP/IP Sockets ---
tcp_connectOpen TCP/IP socket and connect
acceptAccept the next incoming connection
listenListen for incoming connections
htonsConverts a 16 bit word from host to TCP/IP network byte order
sendTransmit a message (TCP)
recvReceive message (TCP)
ResetConnectionAbort a connection on a socket
setlingerSet linger time on close (TCP)
setreuseSet reuse option on a listening socket
Get_TCP_Socket_StateFind TCP socket and return state
FindAllOpenSocketsGet information about all open sockets

        --- UDP Sockets ---
recvfromReceive a datagram and store the source address
sendtoTransmit a datagram

PPP Client Functions

PPP_Client_InstalledCheck if PPP client is installed
PPP_Client_OpenOpen a PPP connection
PPP_Client_CloseClose a PPP client connection
PPP_Client_GetStatusGet PPP client status
PPP_Client_Get_DNSIPGet DNS IP
PPP_Client_SetOptionsSet PPP options for the PPP client
PPP_Client_GetIPGet IP Address of the PPP Client

PPP Server Functions

PPP_Server_InstalledCheck if PPP server is installed
PPP_Server_SuspendSuspend the PPP server task
PPP_Server_ActivateActivate the PPP server
PPP_Server_GetStatusGet the current state of the PPP server
PPP_Server_Get_CfgGet configuration data of the PPP server
PPP_Server_SetOptionsSet PPP options for the PPP server
PPP_Server_GetIPGet IP Address of the PPP Server

Other Functions

        --- Monitoring ---
Get_FTP_Login_CountersAccess the FTP server login counters
Get_Telnet_Login_CountersAccess the Telnet server login counters
Get_Telnet_StateCheck if have an active telnet session
Get_Installed_ServersGet information about running servers
Get_TCPIP_Memory_StatusGet information about TCP/IP stack memory usage
Get_TCPIP_StatisticsAccess the internal network packet counter
Get_SNMP_DataGet internal TCP/IP SNMP variables
Get_SNMP_DataExGet internal TCP/IP SNMP variables (Extended)

        --- DHCP ---
DHCP_useSet/Reset DHCP usage of the Ethernet interface
Get_DHCP_StatusGet DHCP status of the Ethernet interface
Get_DHCP_Status_ExtGet DHCP status of the Ethernet interface

        --- ping ---
Ping_OpenOpen and start ICMP echo requests
Ping_CloseFinish ICMP echo requests
Ping_StatisticsRetrieve ping information

        --- Server Time-outs ---
Set_FTPServer_Idle_TimeoutSet FTP server time-out
Set_TelnetServer_Idle_TimeoutSet Telnet server time-out
Get_FTPServer_Idle_TimeoutGet FTP server time-out value
Get_TelnetServer_Idle_TimeoutGet Telnet server time-out value

        --- Gateway ---
AddDefaultGatewayAdd the default gateway
AddDefaultGatewayExAdd the default gateway (Extended)
DelDefaultGatewayDelete the default gateway
GetDefaultGatewayGet the current default gateway
AddStaticRouteAdd a route for a interface
DelStaticRouteDelete a route from an interface

        --- ARP cache access ---
DelArpEntryByPhysDelete ARP entry by physical address
AddArpEntryAdd an entry in the ARP table
GetARPRouteCacheEntriesRead ARP cache table

        --- IP Multicast ---
Add_IGMP_MembershipInstall an IP multicast address entry
Drop_IGMP_MembershipDelete an IP multicast address entry
IPMulticast_to_MacAddrMap IP multicast address to ethernet address

        --- TCPIP Device driver ---
Dev_Open_InterfaceInstall user device driver
Dev_Close_InterfaceClose user device driver/interface
Dev_Recv_InterfaceReceive and process incoming data
Dev_Recv_WaitWaits for data received signal
Dev_Notify_ISRSignal from Interrupt Service Routine
Dev_Get_BufferGet a buffer from TCP/IP stack
Dev_Send_CompleteSignal message send complete
Dev_Wait_DHCP_CompleteWaits for DHCP completion

        --- Miscellaneous ---
api_sleepSleep for specified number of milliseconds
Reconfigure_ethernetReconfigure Ethernet interface
RegisterIPUserCallbackHandlerRegister an User callback handler for IP
Register_ARP_User_CBRegister an ARP User callback handler.
Get_Iface_EntriesRead table of TCP/IP device interfaces

List of C Libraries
@CHIP-RTOS Main Index


End of document