A2osX/.Docs/LIBTCPIP.md

178 lines
2.2 KiB
Markdown
Raw Normal View History

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