epan/conversation.h

   1 /* conversation.h
   2  * Routines for building lists of packets that are part of a "conversation"
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 #ifndef __CONVERSATION_H__
  26 #define __CONVERSATION_H__
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif /* __cplusplus */
  31
  32 /*
  33  * Flags to pass to "conversation_new()" to indicate that the address 2
  34  * and/or port 2 values for the conversation should be wildcards.
  35  * The CONVERSATION_TEMPLATE option tells that any of the other supplied
  36  * port and / or address wildcards will be used to match an infinite number
  37  * of new connections to the conversation(s) that have the CONVERSATION_-
  38  * TEMPLATE flag set. Any conversation created without the CONVERSATION_-
  39  * TEMPLATE flag will be altered once the first connections (connection
  40  * oriented protocols only) to include the newly found information which
  41  * matched the wildcard options.
  42  */
  43 #define NO_ADDR2 0x01
  44 #define NO_PORT2 0x02
  45 #define NO_PORT2_FORCE 0x04
  46 #define CONVERSATION_TEMPLATE 0x08
  47
  48 /*
  49  * Flags to pass to "find_conversation()" to indicate that the address B
  50  * and/or port B search arguments are wildcards.
  51  */
  52 #define NO_ADDR_B 0x01
  53 #define NO_PORT_B 0x02
  54
  55 #include "packet.h"             /* for conversation dissector type */
  56
  57 /*
  58  * Data structure representing a conversation.
  59  */
  60 typedef struct conversation_key {
  61         struct conversation_key *next;
  62         address addr1;
  63         address addr2;
  64         port_type ptype;
  65         guint32 port1;
  66         guint32 port2;
  67 } conversation_key;
  68
  69 typedef struct conversation {
  70         struct conversation *next;      /* pointer to next conversation on hash chain */
  71         guint32 index;                  /* unique ID for conversation */
  72         guint32 setup_frame;    /* frame number that setup this conversation */
  73         GSList *data_list;              /* list of data associated with conversation */
  74         dissector_handle_t dissector_handle;
  75                                         /* handle for protocol dissector client associated with conversation */
  76         guint   options;                /* wildcard flags */
  77         conversation_key *key_ptr;      /* pointer to the key for this conversation */
  78 } conversation_t;
  79
  80 extern void conversation_cleanup(void);
  81 extern void conversation_init(void);
  82
  83 extern conversation_t *conversation_new(const guint32 setup_frame, const address *addr1, const address *addr2,
  84     const port_type ptype, const guint32 port1, const guint32 port2, const guint options);
  85
  86 extern conversation_t *find_conversation(const guint32 frame_num, const address *addr_a, const address *addr_b,
  87     const port_type ptype, const guint32 port_a, const guint32 port_b, const guint options);
  88
  89 extern conversation_t *find_or_create_conversation(packet_info *pinfo);
  90
  91 extern void conversation_add_proto_data(conversation_t *conv, const int proto,
  92     void *proto_data);
  93 extern void *conversation_get_proto_data(const conversation_t *conv, const int proto);
  94 extern void conversation_delete_proto_data(conversation_t *conv, const int proto);
  95
  96 extern void conversation_set_dissector(conversation_t *conversation,
  97     const dissector_handle_t handle);
  98 extern gboolean
  99 try_conversation_dissector(const address *addr_a, const address *addr_b, const port_type ptype,
 100     const guint32 port_a, const guint32 port_b, tvbuff_t *tvb, packet_info *pinfo,
 101     proto_tree *tree);
 102
 103 /* These routines are used to set undefined values for a conversation */
 104
 105 extern void conversation_set_port2(conversation_t *conv, const guint32 port);
 106 extern void conversation_set_addr2(conversation_t *conv, const address *addr);
 107
 108 #ifdef __cplusplus
 109 }
 110 #endif /* __cplusplus */
 111
 112 #endif /* conversation.h */