From ec9b447be1632ed13e0a904a5d40ee15fd480dbc Mon Sep 17 00:00:00 2001 From: likewise Date: Sun, 17 Oct 2004 21:28:25 +0000 Subject: [PATCH] 17th October 2004 Leon Woestenberg rawapi.txt: Explicitly name full nomenclature for two different API's. --- doc/rawapi.txt | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/rawapi.txt b/doc/rawapi.txt index 2c88ca28..6d1c93ca 100644 --- a/doc/rawapi.txt +++ b/doc/rawapi.txt @@ -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 -to use for communication with the TCP/IP code: the sequential API -(often just called "the API") and the raw TCP/IP interface. This -document is intended as a description of the latter. For lwIP versions -lower than 0.5, this API was not documented. +to use for communication with the TCP/IP code: +* low-level "core" / "callback" or "raw" API. +* higher-level "sequential" API. 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 -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 code and the application program must reside in different execution contexts (threads). +** The remainder of this document discusses the "raw" API. ** + The raw TCP/IP interface allows the application program to integrate better with the TCP/IP code. Program execution is event based by 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 program using the raw TCP/IP interface. - --- Callbacks Program execution is driven by callbacks. Each callback is an ordinary