epan/epan.h

   1 /* epan.h
   2  *
   3  * $Id$
   4  *
   5  * Wireshark Protocol Analyzer Library
   6  *
   7  * Copyright (c) 2001 by Gerald Combs <gerald@wireshark.org>
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; either version 2
  12  * of the License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22  */
  23
  24 #ifndef EPAN_H
  25 #define EPAN_H
  26
  27 #include <glib.h>
  28 #include "frame_data.h"
  29 #include "column_info.h"
  30 #include "register.h"
  31
  32 typedef struct _epan_dissect_t epan_dissect_t;
  33
  34 #include "dfilter/dfilter.h"
  35
  36 /* init the whole epan module, this is used to be called only once in a program */
  37 void epan_init(void (*register_all_protocols_func)(register_cb cb, gpointer client_data),
  38                void (*register_all_handoffs_func)(register_cb cb, gpointer client_data),
  39                register_cb cb,
  40                void *client_data,
  41                void (*report_failure)(const char *, va_list),
  42                void (*report_open_failure)(const char *, int, gboolean),
  43                void (*report_read_failure)(const char *, int),
  44                void (*report_write_failure)(const char *, int));
  45
  46 /* cleanup the whole epan module, this is used to be called only once in a program */
  47 void epan_cleanup(void);
  48
  49 /*
  50  * Initialize the table of conversations.  Conversations are identified by
  51  * their endpoints; they are used for protocols such as IP, TCP, and UDP,
  52  * where packets contain endpoint information but don't contain a single
  53  * value indicating to which flow the packet belongs.
  54  */
  55 void epan_conversation_init(void);
  56
  57 /*
  58  * Initialize the table of circuits.  Circuits are identified by a
  59  * circuit ID; they are used for protocols where packets *do* contain
  60  * a circuit ID value indicating to which flow the packet belongs.
  61  *
  62  * We might want to make a superclass for both endpoint-specified
  63  * conversations and circuit ID-specified circuits, so we can attach
  64  * information either to a circuit or a conversation with common
  65  * code.
  66  */
  67 void epan_circuit_init(void);
  68
  69 /* A client will create one epan_t for an entire dissection session.
  70  * A single epan_t will be used to analyze the entire sequence of packets,
  71  * sequentially, in a single session. A session corresponds to a single
  72  * packet trace file. The reaons epan_t exists is that some packets in
  73  * some protocols cannot be decoded without knowledge of previous packets.
  74  * This inter-packet "state" is stored in the epan_t.
  75  */
  76 /* XXX - NOTE: epan_t, epan_new and epan_free are currently unused! */
  77 typedef struct epan_session epan_t;
  78
  79 epan_t*
  80 epan_new(void);
  81
  82 void
  83 epan_free(epan_t*);
  84
  85 extern gchar*
  86 epan_get_version(void);
  87
  88 /* initialize an existing single packet dissection */
  89 epan_dissect_t*
  90 epan_dissect_init(epan_dissect_t        *edt, gboolean create_proto_tree, gboolean proto_tree_visible);
  91
  92 /* get a new single packet dissection */
  93 /* should be freed using epan_dissect_free() after packet dissection completed */
  94 epan_dissect_t*
  95 epan_dissect_new(gboolean create_proto_tree, gboolean proto_tree_visible);
  96
  97 /* Indicate whether we should fake protocols or not */
  98 void
  99 epan_dissect_fake_protocols(epan_dissect_t *edt, gboolean fake_protocols);
 100
 101 /* run a single packet dissection */
 102 void
 103 epan_dissect_run(epan_dissect_t *edt, void* pseudo_header,
 104         const guint8* data, frame_data *fd, column_info *cinfo);
 105
 106 /* Prime a proto_tree using the fields/protocols used in a dfilter. */
 107 void
 108 epan_dissect_prime_dfilter(epan_dissect_t *edt, const dfilter_t *dfcode);
 109
 110 /* fill the dissect run output into the packet list columns */
 111 void
 112 epan_dissect_fill_in_columns(epan_dissect_t *edt, gboolean fill_fd_colums);
 113
 114 /* releases resources attached to the packet dissection. DOES NOT free the actual pointer */
 115 void
 116 epan_dissect_cleanup(epan_dissect_t* edt);
 117
 118 /* free a single packet dissection */
 119 void
 120 epan_dissect_free(epan_dissect_t* edt);
 121
 122 #endif /* EPAN_H */