osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

Update documentation about p_[add|get]_proto_data (new argument: scope) 

Change-Id: Ic27b0e601967c90567fac58447d28b10c02a3888
Reviewed-on: https://code.wireshark.org/review/564
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Tested-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
This commit is contained in:
Michael Mann 2014-03-09 11:02:30 +01:00 committed by Anders Broman
parent a6ed603f5c
commit 839b5b258c
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/README.dissector
View File

@ -2645,16 +2645,22 @@ static dissector_handle_t sub_dissector_handle;
Information can be stored for each data packet that is processed by the Information can be stored for each data packet that is processed by the
dissector. The information is added with the p_add_proto_data function and dissector. The information is added with the p_add_proto_data function and
retrieved with the p_get_proto_data function. The data pointers passed into retrieved with the p_get_proto_data function. The data pointers passed into
the p_add_proto_data are not managed by the proto_data routines. If you use the p_add_proto_data are not managed by the proto_data routines, however the
malloc or any other dynamic memory allocation scheme, you must release the data pointer memory scope must match that of the scope parameter.
data when it isn't required. The two most common use cases for p_add_proto_data/p_get_proto_data are for
persistent data about the packet for the lifetime of the capture (file scope)
and to exchange data between dissectors across a single packet (packet scope).
It is also used to provide packet data for Decode As dialog (packet scope).
void void
p_add_proto_data(frame_data *fd, int proto, void *proto_data) p_add_proto_data(wmem_allocator_t *scope, frame_data *fd, int proto, void *proto_data)
void * void *
p_get_proto_data(frame_data *fd, int proto) p_get_proto_data(wmem_allocator_t *scope, frame_data *fd, int proto)
Where: Where:
scope - Lifetime of the data to be stored, typically wmem_file_scope()
or pinfo->pool (packet scope). Must match scope of data
allocated.
fd - The fd pointer in the pinfo structure, pinfo->fd fd - The fd pointer in the pinfo structure, pinfo->fd
proto - Protocol id returned by the proto_register_protocol call proto - Protocol id returned by the proto_register_protocol call
during initialization during initialization