aboutsummaryrefslogtreecommitdiffstats
path: root/epan/register.h
diff options
context:
space:
mode:
Diffstat (limited to 'epan/register.h')
-rw-r--r--epan/register.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/epan/register.h b/epan/register.h
new file mode 100644
index 0000000000..55c72c2464
--- /dev/null
+++ b/epan/register.h
@@ -0,0 +1,87 @@
+/* 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+
+ */
+
+#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_LOCAL void register_all_tap_listeners(void);
+
+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:
+ */