epan/conversation.h

   1 /* conversation.h
   2  * Routines for building lists of packets that are part of a "conversation"
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   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 /*
  29  * Flags to pass to "conversation_new()" to indicate that the address 2
  30  * and/or port 2 values for the conversation should be wildcards.
  31  * The CONVERSATION_TEMPLATE option tells that any of the other supplied
  32  * port and / or address wildcards will be used to match an infinite number
  33  * of new connections to the conversation(s) that have the CONVERSATION_-
  34  * TEMPLATE flag set. Any conversation created without the CONVERSATION_-
  35  * TEMPLATE flag will be altered once the first connections (connection
  36  * oriented protocols only) to include the newly found information which
  37  * matched the wildcard options.
  38  */
  39 #define NO_ADDR2 0x01
  40 #define NO_PORT2 0x02
  41 #define NO_PORT2_FORCE 0x04
  42 #define CONVERSATION_TEMPLATE 0x08
  43
  44 /*
  45  * Flags to pass to "find_conversation()" to indicate that the address B
  46  * and/or port B search arguments are wildcards.
  47  */
  48 #define NO_ADDR_B 0x01
  49 #define NO_PORT_B 0x02
  50 #define NO_PORT_B_FORCE 0x04
  51
  52 #include "packet.h"             /* for conversation dissector type */
  53
  54 /*
  55  * Data structure representing a conversation.
  56  */
  57 typedef struct conversation_key {
  58         struct conversation_key *next;
  59         address addr1;
  60         address addr2;
  61         port_type ptype;
  62         guint32 port1;
  63         guint32 port2;
  64 } conversation_key;
  65
  66 typedef struct conversation {
  67         struct conversation *next;      /* pointer to next conversation on hash chain */
  68         guint32 index;                  /* unique ID for conversation */
  69         guint32 setup_frame;    /* frame number that setup this conversation */
  70         GSList *data_list;              /* list of data associated with conversation */
  71         dissector_handle_t dissector_handle;
  72                                         /* handle for protocol dissector client associated with conversation */
  73         guint   options;                /* wildcard flags */
  74         conversation_key *key_ptr;      /* pointer to the key for this conversation */
  75 } conversation_t;
  76
  77 extern void conversation_init(void);
  78
  79 extern conversation_t *conversation_new(guint32 setup_frame, address *addr1, address *addr2,
  80     port_type ptype, guint32 port1, guint32 port2, guint options);
  81
  82 extern conversation_t *find_conversation(guint32 frame_num, address *addr_a, address *addr_b,
  83     port_type ptype, guint32 port_a, guint32 port_b, guint options);
  84
  85 extern void conversation_add_proto_data(conversation_t *conv, int proto,
  86     void *proto_data);
  87 extern void *conversation_get_proto_data(conversation_t *conv, int proto);
  88 extern void conversation_delete_proto_data(conversation_t *conv, int proto);
  89
  90 extern void conversation_set_dissector(conversation_t *conversation,
  91     dissector_handle_t handle);
  92 extern gboolean
  93 try_conversation_dissector(address *addr_a, address *addr_b, port_type ptype,
  94     guint32 port_a, guint32 port_b, tvbuff_t *tvb, packet_info *pinfo,
  95     proto_tree *tree);
  96
  97 /* These routines are used to set undefined values for a conversation */
  98
  99 extern void conversation_set_port2(conversation_t *conv, guint32 port);
 100 extern void conversation_set_addr2(conversation_t *conv, address *addr);
 101
 102 #endif /* conversation.h */