A2osX/_Docs/LIBTCPIP.md

181 lines
2.2 KiB
Markdown
Raw Normal View History

*** Auto generated by docgen.cmd ***
2017-02-15 15:47:20 +00:00
#ARP.Clear
+ Clear ARP Cache
##In :
##Out :
#ARP.Query
+ Query ARP Cache and returns HW address
##In:
+ PUSHW PTR to MAC (to fill)
+ PUSHW PTR to IP
##Out:
+ CC: hit: MAC filled
+ CS: missed
#ARP.Add
+ Add a static ARP cache record
##In:
+ PUSHW PTR to MAC
+ PUSHW PTR to IP
#ARP.GetCache
+ Return a Ptr to ARP Cache Table
##In:
##Out:
+ Y,A = PTR to ARP.CACHE
#DNS.Clear
+ Clear DNS Cache
##In :
##Out :
#DNS.Query
+ Query DNS for specified host
##In:
+ PUSHW = PTR to IP to fill with cached data
* PUSHW = hostname PTR to PSTR
##Out:
+ CC: hit: IP filled with address
+ CS: missed
2017-02-15 16:03:27 +00:00
#DNS.Add
2017-02-15 15:47:20 +00:00
+ Add a static DNS record
##In:
+ PUSHW = PTR to IP
+ PUSHW = hostname PSTR to Add
#DNS.GetCache
+ Return a Ptr to DNS Cache Table
##In:
##Out:
+ Y,A = PTR to DNS.CACHE
#SKT.New
2017-02-13 07:26:18 +00:00
+ Create a new socket
##In :
+ PUSHW = PTR to S.SOCKET template
##Out :
+ YA = PTR to new S.SOCKET
+ X = hSocket
2017-02-13 07:26:18 +00:00
2017-02-15 15:47:20 +00:00
#SKT.CloseA
+ Close socket
##In :
+ A = hSocket
##Out :
#SKT.GetA
+ Get Ptr to socket
##In :
+ A = hSocket
##Out :
+ Y,A = pS.SOCKET
#SKT.GetTable
+ Get socket table
##In :
##Out :
+ Y,A = pS.SOCKET
2017-02-13 07:26:18 +00:00
#SKT.AcceptA
+ Check for an incoming connection
##In :
+ A = hListeningSocket
##Out :
+ A = hSocket
#SKT.Write (DGRAM,STREAM,RAW)
2017-02-13 07:26:18 +00:00
+ Send block of data
##In :
+ PUSHB = hSocket
+ PUSHW = pBuf
+ PUSHW = len
##Out :
+ A = hFrame
#SKT.ReadA (DGRAM,RAW)
2017-02-13 07:26:18 +00:00
##In :
+ A = hSocket
##Out :
+ A = hFrame
2017-02-15 15:47:20 +00:00
#SKT.PutC (STREAM)
+ Write a Char To Stream
##In :
+ PUSHB = hSocket
+ PUSHB = Char
##Out :
+ A = char
#SKT.PutS (STREAM)
+ Write Line in pBuf
##In :
+ PUSHB = hSocket
+ PUSHW = PSTR
##Out :
2017-02-13 07:26:18 +00:00
#SKT.GetCA (STREAM)
+ Read a Char From Stream in A
##In :
+ A = hSocket
##Out :
+ A = char
#SKT.GetS (STREAM)
+ Read a CR terminated Line in pBuf
##In :
+ PUSHB = hSocket
+ PUSHW = pBuf
+ PUSHW = len
##Out :
+ Y,A = bytes read
2017-02-15 15:47:20 +00:00
#SKT.Read (STREAM)
2017-02-13 07:26:18 +00:00
+ Read data in pBuf
##In :
+ PUSHB = hSocket
+ PUSHW = pBuf
+ PUSHW = len
##Out :
+ Y,A = bytes transfered