TCP/IP Management Programming Manual

Elements of SPI Messages
HP NonStop TCP/IP Management Programming Manual—529636-001
3-8
Tokens
Tokens
The TCP/IP subsystem uses tokens for parameters and responses to commands, and
for elements of event messages. Each token has a token code and token value
associated with it. The token code is the identifying tag that programs use to refer to
the token by name. The token value is the actual data item that is assigned to the
token code. The token code has two parts: a token type that specifies the data type
and length of the token value, and a token number that uniquely identifies the token for
the subsystem. For a list of the token types used in the TCP/IP subsystem, see
Section 5, Common Definitions.
The actual token value can be in one of these forms:
•
A single field, such as an integer or a character string
•
A fixed structure, which consists of a fixed number of data fields that are always
present
•
An extensible structure, which consists of data fields whose number can be
extended from release to release and may contain fields with null (unassigned)
values
Tokens that have a token value that is a single field or a fixed structure are called
simple tokens. Tokens that have a token value that is an extensible structure are called
extensible structured tokens.
Simple Tokens
Simple tokens are tokens whose values are single fields or fixed structures. They are
identified by token codes. They are considered simple tokens because you do not
need a map to build and decode their internal structure. The token codes for the simple
tokens used by the TCP/IP subsystem are represented by symbolic names of the form
Zsubsys-TKN-name, where subsys is a three-character subsystem abbreviation and
name identifies the token code. For example, the token code ZEMS-TKN-LDEV
identifies a simple token that contains a logical device number.
All the token codes defined by the TCP/IP subsystem (token codes with names of the
form ZTCI-TKN-name) can be found in Section 5, Common Definitions.
Extensible Structured Tokens
Extensible structured tokens are tokens whose values are extensible structures and
are identified by token maps. The token maps for the extensible structured tokens used
by the TCP/IP subsystem are represented by symbolic names of the form
Zsubsys-MAP-name, where subsys is a three-character subsystem abbreviation and
name identifies the token map. For example, the token map ZTCI-MAP-INFO-ROUTE
identifies an extensible structured token that contains all the dynamic parameters for
the specified route.
Extensible structured tokens are declared in the DDL files for each subsystem. Within
an extensible structured token, you may find fields that are identified by predefined