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 mapper 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 : the name of the field 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. You can also access slices of the array using name(x-y), name(x-), name(-y) or name(-) (which access all the elements). for mapper filed, the name alone means all the subfields. The access one member, use a dotted notation (e.g. name.subfield). for flags field, access to the value of one flag using the dotted notation (e.g. fieldname.flag). This is allowed only for whet getting a value. use combination of the above rules when the protocol is complex. For example, a valid name is : name(2).subfield.subsubfield(2-4) When accessing an array, the index is checked by the program. If it exceeds the bound of the array, the program will either ignore the value or generate an error depending on the value of indexOutOfBoundIsError.

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 (e.g. numerical value) and verbose description (when applicable, for example in list, flags and IP addresses).

packetName mapperName setraw field value

These command is a variation of the configure command too. It allows to write raw data for types supporting that feature.

packetName mapperName prettyprint field data

These command run the prettyprint script specified by the user in the mapper definition.

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

packetName mapperName help ?field? help string

Returns some help about the mapper 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 ?ondemand?}

Returns the multiplicity (single or array) and the type of a field (integer, string, list, ...). If the type has been specified ondemand, then this is indicated in the last item of the list.

packetName mapperName setdefaults

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

packetName mapperName setchecksum packetName mapperName validatechecksum packetName mapperName setlength checksum 0 or 1 length

For the special field using the checksum type, compute and set the checksum, then returns the value. The validate command compute the checksum from the actual values are return 0 if it is incorrect, 1 if correct. For the special field using the length type, compute and set the length, then returns the value.

packetName mapperName parent ?newParent? parent

Get or set the parent of a mapper. The parent is used when accessing '%value' or '%string' with a parent mapper specified. The parent is also used in the 'checksum(tcp)' algorithm to get the IP addresses.