A2osX/.Docs/LIBTCPIP.md

178 lines
2.3 KiB
Markdown
Raw Normal View History

*** Auto generated by docgen.cmd ***
2017-03-30 09:03:23 +00:00
# ARP.Clear
+ Clear ARP Cache
## In :
## Out :
# ARP.Query
+ Query ARP Cache and returns HW address
2018-06-14 15:31:36 +00:00
**In:**
2017-03-30 09:03:23 +00:00
+ PUSHW PTR to MAC (to fill)
+ PUSHW PTR to IP
2018-06-14 15:31:36 +00:00
**Out:**
2017-03-30 09:03:23 +00:00
+ CC: hit: MAC filled
+ CS: missed
# ARP.Add
+ Add a static ARP cache record
2018-06-14 15:31:36 +00:00
**In:**
2017-03-30 09:03:23 +00:00
+ PUSHW PTR to MAC
+ PUSHW PTR to IP
# ARP.GetCAche
2017-03-30 09:03:23 +00:00
+ Return a Ptr to ARP Cache Table
2018-06-14 15:31:36 +00:00
**In:**
**Out:**
2017-03-30 09:03:23 +00:00
+ Y,A = PTR to ARP.CACHE
# DNS.Clear
+ Clear DNS Cache
## In :
## Out :
# DNS.Query
+ Query DNS for specified host
2018-06-14 15:31:36 +00:00
**In:**
2017-03-30 09:03:23 +00:00
+ PUSHW = PTR to IP to fill with cached data
* PUSHW = hostname PTR to PSTR
2018-06-14 15:31:36 +00:00
**Out:**
2017-03-30 09:03:23 +00:00
+ CC: hit: IP filled with address
+ CS: missed
# DNS.Add
+ Add a static DNS record
2018-06-14 15:31:36 +00:00
**In:**
2017-03-30 09:03:23 +00:00
+ PUSHW = PTR to IP
+ PUSHW = hostname CSTR to Add
2017-03-30 09:03:23 +00:00
# DNS.GetCAche
2017-03-30 09:03:23 +00:00
+ Return a Ptr to DNS Cache Table
2018-06-14 15:31:36 +00:00
**In:**
**Out:**
2017-03-30 09:03:23 +00:00
+ Y,A = PTR to DNS.CACHE
# SKT.New
+ Create a new socket
## In :
+ PUSHW = PTR to S.SOCKET template
## Out :
+ YA = PTR to new S.SOCKET
+ X = hSocket
# 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
# SKT.AcceptA
+ Check for an incoming connection
## In :
+ A = hListeningSocket
## Out :
+ A = hSocket
# SKT.MkNodA
+ Create a new file from TCP socket
## In :
+ A = hSocket
## Out :
+ A = hFile
# SKT.Write (DGRAM,STREAM,RAW)
+ Send block of data
## In :
+ PUSHB = hSocket
+ PUSHW = pBuf
+ PUSHW = len
## Out :
# SKT.ReadA (DGRAM,RAW)
## In :
+ A = hSocket
## Out :
+ A = hFrame
# SKT.PutC (STREAM)
+ Write a Char To Stream
## In :
+ PUSHB = hSocket
+ PUSHB = Char
## Out :
# SKT.PutS (STREAM)
+ Write Line in pBuf
## In :
+ PUSHB = hSocket
+ PUSHW = PSTR
## Out :
# SKT.GetC.A (STREAM)
2017-03-30 09:03:23 +00:00
+ 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
# SKT.Read (STREAM)
+ Read data in pBuf
## In :
+ PUSHB = hSocket
+ PUSHW = pBuf
+ PUSHW = len
## Out :
+ Y,A = bytes transfered