diff options
| author | John Thacker <johnthacker@gmail.com> | 2023-01-16 21:53:37 -0500 |
|---|---|---|
| committer | Alexis La Goutte <alexis.lagoutte@gmail.com> | 2023-01-17 09:27:29 +0000 |
| commit | ffdf332f24b08c39797d395129563e97e3ad4934 (patch) | |
| tree | 13c876e435f910bd8480ee1b15fd3ee962b82960 /doc | |
| parent | d851134d898577d771d049cfd3166c7d5579e177 (diff) | |
docs: Explain the FT_FRAMENUM use of the strings field
Add a section about FRAMENUM_TYPE to the 'strings' field
section of README.dissector
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.dissector | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/README.dissector b/doc/README.dissector index ef38ad955f..8de7d74360 100644 --- a/doc/README.dissector +++ b/doc/README.dissector @@ -1247,6 +1247,22 @@ in tfs.h, included via packet.h. Custom fields (BASE_CUSTOM) should use CF_FUNC(&custom_format_func) for the 'strings' field. +-- Frame numbers +FT_FRAMENUMs can use the 'strings' field to indicate their purpose by +setting the field to 'FRAMENUM_TYPE(x)', where x is one of the values of +the ft_framenum_type enum: + + FT_FRAMENUM_NONE + FT_FRAMENUM_REQUEST + FT_FRAMENUM_RESPONSE + FT_FRAMENUM_ACK + FT_FRAMENUM_DUP_ACK + FT_FRAMENUM_RETRANS_PREV + FT_FRAMENUM_RETRANS_NEXT + +The packet list uses the value to determine the related packet symbol to draw. +Note that 'strings' field NULL is equal to FRAMENUM_TYPE(FT_FRAMENUM_NONE). + -- Note to plugin authors Data cannot get exported from DLLs. For this reason plugin authors cannot use existing fieldconvert strings (e.g. from existing dissectors or those from |