User`s guide

4
K
A
DAK
KwikNet Overview
The KwikNet User's Guide
Chapter 1 provides an overview of the KwikNet TCP/IP Stack. The general operation of
KwikNet is described and the nomenclature used by KADAK is introduced. Appendix A
includes a glossary which will help when you are stuck trying to remember what one of
the many protocol mnemonics means. A number of topics unrelated to network issues
are covered in this chapter. KwikNet memory allocation requirements are examined.
KwikNet data logging, message recording, console support and debugging features are also
presented. Finally, the KwikNet TCP/IP Sample Program used to exercise KwikNet and
illustrate its proper use is described in a tutorial fashion.
Chapter 2 is your system configuration guide. You may wish to read this chapter to
learn how easy it is to use the KwikNet Configuration Builder to customize KwikNet for
your use.
Chapter 3 describes how KwikNet is configured for use and combined with your
application to form an executable load module. It also describes how users of KADAK's
AMX Real-Time Multitasking Kernel must adapt their AMX configuration for use with
KwikNet. If you are porting KwikNet to your own operating environment, the material
provided in this chapter will simply augment the more detailed description presented in
the KwikNet Porting Kit User' Guide.
Chapter 4 presents the KwikNet network and IP/UDP application programming interface
(API). This chapter includes descriptions of the lower level (IP and UDP) services which
are available for applications which choose not to use the TCP protocol and its socket
interface. Topics such as the UDP programming interface, the DHCP and DNS clients
and PING are also covered. Network management services for adding new networks and
opening and closing existing networks are described in this chapter. It also describes
common utility procedures which are available for use by applications and device drivers.
Chapter 5 presents the KwikNet socket application programming interface (socket API).
It includes an alphabetic summary of all the KwikNet socket procedures at your disposal.
Chapter 6 presents the KwikNet PPP Option. This optional KwikNet component is an
implementation of the Point-to-Point Protocol (PPP) commonly used with serial network
interfaces. This chapter describes how to incorporate and use PPP in your application.
Chapter 7 describes the KwikNet Virtual File System (VFS), its API and the VFS
Generator which creates the VFS image for incorporation into your application. The VFS
is a read-only file system which is well suited for use with protocols like HTTP as
implemented by the
KwikNet Web Server.
Other optional KwikNet components (FTP, SMTP, SNMP, TFTP, Telnet, Web Server etc.)
are described in separate manuals. For some of these protocols, the programming
interface is described in the Treck TCP/IP User Manual or its companion documents.
These optional components will be of interest only if you have purchased and are using
the relevant
KwikNet options.