17th October 2004 Leon Woestenberg <leon.woestenberg@gmx.net>

rawapi.txt: Explicitly name full nomenclature for two different API's.
This commit is contained in:
likewise 2004-10-17 21:28:25 +00:00
parent 99e3fe9ae1
commit ec9b447be1

View File

@ -1,20 +1,21 @@
Raw TCP/IP interface for lwIP 0.5 Raw TCP/IP interface for lwIP
Author: Adam Dunkels Authors: Adam Dunkels, Leon Woestenberg
lwIP provides two Application Program's Interfaces (APIs) for programs lwIP provides two Application Program's Interfaces (APIs) for programs
to use for communication with the TCP/IP code: the sequential API to use for communication with the TCP/IP code:
(often just called "the API") and the raw TCP/IP interface. This * low-level "core" / "callback" or "raw" API.
document is intended as a description of the latter. For lwIP versions * higher-level "sequential" API.
lower than 0.5, this API was not documented.
The sequential API provides a way for ordinary, sequential, programs The sequential API provides a way for ordinary, sequential, programs
to use the lwIP stack. It is quite similar to the BSD socket API. The to use the lwIP stack. It is quite similar to the BSD socket API. The
model of execution is based on the open-read-write-close model of execution is based on the blocking open-read-write-close
paradigm. Since the TCP/IP stack is event based by nature, the TCP/IP paradigm. Since the TCP/IP stack is event based by nature, the TCP/IP
code and the application program must reside in different execution code and the application program must reside in different execution
contexts (threads). contexts (threads).
** The remainder of this document discusses the "raw" API. **
The raw TCP/IP interface allows the application program to integrate The raw TCP/IP interface allows the application program to integrate
better with the TCP/IP code. Program execution is event based by better with the TCP/IP code. Program execution is event based by
having callback functions being called from within the TCP/IP having callback functions being called from within the TCP/IP
@ -34,7 +35,6 @@ Both APIs can be used simultaneously by different application
programs. In fact, the sequential API is implemented as an application programs. In fact, the sequential API is implemented as an application
program using the raw TCP/IP interface. program using the raw TCP/IP interface.
--- Callbacks --- Callbacks
Program execution is driven by callbacks. Each callback is an ordinary Program execution is driven by callbacks. Each callback is an ordinary