A2osX/.Docs/LIBTCPIP.md

2.3 KiB

*** Auto generated by docgen.cmd ***

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

DNS.Add

  • Add a static DNS record

In:

  • PUSHW = PTR to IP
  • PUSHW = hostname CSTR to Add

DNS.GetCAche

  • Return a Ptr to DNS Cache Table

In:

Out:

  • 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)

  • 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