Concept |  Packet |  Mapper |  Network |  Procotol language |  Utilities |  Launching |  FAQ 

packetName mapperName offset ?offset?
offset in packet
  Without argument, returns the offset of the mapper named mapperNamed.
With a numnerical value, set the offset of the mapper.

packetName mapperName configure
packetName mapperName configure ?field?
packetName mapperName configure ?field value ...?
datas
data

  This is the central command used to query and set values.

Without argument, the command returns the list of all the fields defined in the protocol with their value. To get the value of one field, just append its name after configure.

To set one or more values, append one or more couples of field/value. The accepted values depends on the type of the field (integer, string, list, flag, address, ...).

The rule to name a field is :

  1. the name of the field
  2. for array field, the name alone means the whole array. Explicit the index to access an identified value inside the array (e.g. name(1)). The elements are indexed from 0.
  3. for mapper filed, the name alone means all the subfields. The access one member, use a dotted notation (e.g. name.subfield).
  4. use combination of the above rules when the protocol is complex. For example, a valid name is : name(2).subfield.subsubfield(0)

packetName mapperName getraw ?field?
packetName mapperName getverbose ?field?
data(s)
data(s)
  These two commands are variation of the configure command. They allow access respectively to raw data (numerical value) and verbose description (when applicable, for example in list, flags and IP addresses).

 

Now, let describe some helper commands to get special info about the mappers.

packetName mapperName help ?field?
help string
  Returns some help about the protocol decoded in mapperName. Without arguments, returns all the fields and the source used for the specification. With the name of a field given, returns the help associated with this field.

packetName mapperName values field
list predefined values
  For list type, build and returns the list of predefined values.

packetName mapperName limits ?field?
{low up}
  Return the lower and upper bounds (in bytes) of either a given mapper (or element of mapper, or subfield of a mapper) or the set of all the mappers.

packetName mapperName size
size
  Return the size (in bytes) of a mapper. This size is computed on the fly if needed.

packetName mapperName type field
{multiplicity type}
  Returns the multiplicity (single or array) and the type of a field (integer, string, list, ...)

packetName mapperName setdefaults

  Write the default values for fields in packet memory as given in protocol description.

packetName mapperName setchecksum
packetName mapperName setlength
checksum
length
  For the special field using the checksum type, compute and set the checksum, then returns the value. For the special field using the length type, compute and set the length, then returns the value.


Copyright © 2000 Laurent Riesterer.
Last modified on Mar 2, 2000.