wireshark/epan/register.h

86 lines
2.7 KiB
C

/* register.h
* Definitions for protocol registration
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __REGISTER_H__
#define __REGISTER_H__
#include "ws_symbol_export.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
#include <glib.h>
typedef enum {
RA_NONE, /* For initialization */
RA_DISSECTORS, /* Initializing dissectors */
RA_LISTENERS, /* Tap listeners */
RA_EXTCAP, /* extcap register preferences */
RA_REGISTER, /* Built-in dissector registration */
RA_PLUGIN_REGISTER, /* Plugin dissector registration */
RA_HANDOFF, /* Built-in dissector handoff */
RA_PLUGIN_HANDOFF, /* Plugin dissector handoff */
RA_LUA_PLUGINS, /* Lua plugin register */
RA_LUA_DEREGISTER, /* Lua plugin deregister */
RA_PREFERENCES, /* Module preferences */
RA_INTERFACES /* Local interfaces */
} register_action_e;
#define RA_BASE_COUNT (RA_INTERFACES - 3) // RA_EXTCAP, RA_LUA_PLUGINS, RA_LUA_DEREGISTER
typedef void (*register_cb)(register_action_e action, const char *message, gpointer client_data);
/** Call each dissector's protocol registration routine.
*
* Each routine is called in alphabetical order from a worker thread.
* Registration routines might call any number of routines which are not
* thread safe, such as wmem_alloc. Callbacks should handle themselves
* accordingly.
*
* @param cb Callback routine which is called for each protocol.
* Messages have the format "proto_register_XXX".
* @param client_data Data pointer for the callback.
*/
WS_DLL_PUBLIC void register_all_protocols(register_cb cb, gpointer client_data);
/** Call each dissector's protocol handoff routine.
*
* Each routine is called from a worker thread. Registration routines
* might call any number of routines which are not thread safe, such as
* wmem_alloc. Callbacks should handle themselves accordingly.
*
* @param cb Callback routine which is called for each protocol.
* Messages have the format "proto_reg_handoff_XXX".
* @param client_data Data pointer for the callback.
*/
WS_DLL_PUBLIC void register_all_protocol_handoffs(register_cb cb, gpointer client_data);
WS_DLL_PUBLIC gulong register_count(void);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __REGISTER_H__ */
/*
* Editor modelines - http://www.wireshark.org/tools/modelines.html
*
* Local Variables:
* c-basic-offset: 4
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* vi: set shiftwidth=4 tabstop=8 expandtab:
* :indentSize=4:tabSize=8:noTabs=true:
*/