User`s guide

146
K
A
DAK
KwikNet Low Level Services
KwikNet
Procedure Descriptions (continued)
Used by n Task o ISP o Timer Procedure o Restart Procedure o Exit Procedure
For other multitasking systems, a task is any application task executing at
a priority below that of the
KwikNet Task. A Timer Procedure is a function
executed by a task of higher priority than the
KwikNet Task. An ISP is a
KwikNet device driver interrupt handler called from an RTOS compatible
interrupt service routine. The other procedures do not exist.
For a single threaded system, your App-Task (see glossary in Appendix A)
is the only task. An ISP is a KwikNet device driver interrupt handler called
from an interrupt service routine. The other procedures do not exist.
Setup The prototype of the
KwikNet procedure is shown.
The
KwikNet header file in which the prototype is located is identified.
Include KwikNet header file KN_LIB.H or KN_SOCK.H for compilation.
File KN_LIB.H is the KwikNet Library Header File used to compile the
KwikNet Library which your application uses. This file is created for you
by the KwikNet Configuration Builder when you create your KwikNet
Library. File KN_LIB.H automatically includes the correct subset of the
KwikNet and Treck header files for a particular target processor.
File KN_SOCK.H is the KwikNet include file which you must include if your
application uses the KwikNet TCP/IP sockets API. This file can be found
in the Treck installation directory TRECK\INCLUDE. File KN_SOCK.H
automatically includes file KN_LIB.H if it has not already been included.
Description Defines all input parameters to the procedure and expands upon the
purpose or method if required.
Returns The outputs, if any, produced by the procedure are always defined. Most
KwikNet procedures return an integer error status. Additional TCP/IP
socket error information is also available via
KwikNet procedure
kn_errno().
Restrictions If any restrictions on the use of the procedure exist, they are described.
Note Special notes, suggestions or warnings are offered where necessary. The
following paragraph is an example of such a note.
All KwikNet procedures assume that an integer or unsigned integer is a
16 or 32-bit value dependent only upon the basic register width of the
target processor.
Example In many cases, a simple example is provided. The examples are kept
simple and are intended only to illustrate the correct calling sequence.
See Also A cross reference to other related KwikNet procedures is always provided if
applicable.