|
|
|
|
This section explains how information is organized and presented in this book.
This book is organized as follows:
Introduction to the NOF API, provides an overview of the SNAP-IX NOF API and the functions it provides.
Writing NOF Applications, contains general information a programmer needs when writing NOF applications and information about compiling and linking the applications.
NOF API Verbs, provides a detailed description of each of the NOF verbs, including parameters and return codes.
NOF Indications, provides a detailed description of each of the indications that a NOF application can register to receive.
Common Return Codes, provides information about return codes that are common to all the NOF verbs.
Typographic Conventions shows the typographic styles used in this document.
| Special Element | Sample of Typography |
| Document title | SNAP-IX NOF Programmer's Guide |
| File or path name | sna.err |
| Directory name | /var/opt/sna |
| Header file | nof_c.h |
| Program or application | snaadmin |
| Command | define_local_lu; cd |
| General reference to all verbs of a particular type | DEFINE_* (indicates all of the NOF API verbs that define resources) |
| Option or flag | |
| Parameter | opcode |
| Literal value or selection that the user can enter (including default values) | 255 |
| Constant | |
| Return value | AP_INVALID_FORMAT; 0 |
| Variable representing a supplied value | a.b.c.d |
| Environment variable | |
| Programming verb | CONNECT_NODE |
| User input | snaadmin status_dependent_lu,pu_name=ETH0 |
| Function, call, or entry point | ioctl |
| Data structure | |
| Hexadecimal value | 0x20 |
|
|
|
 |
|