epan/frame_data.h

   1 /* frame_data.h
   2  * Definitions for frame_data structures and routines
   3  *
   4  * $Id: frame_data.h,v 1.13 2004/01/31 04:10:05 guy Exp $
   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 __FRAME_DATA_H__
  26 #define __FRAME_DATA_H__
  27
  28 #include "column_info.h"
  29 #include "tvbuff.h"
  30
  31 #if 0
  32 /* Defined in color.h */
  33 #ifndef __COLOR_H__
  34 typedef struct _color_t /* {
  35         guint32 pixel;
  36         guint16 red;
  37         guint16 green;
  38         guint16 blue;
  39 } */ color_t;
  40 #endif
  41 #endif
  42
  43 /* XXX - some of this stuff is used only while a packet is being dissected;
  44    should we keep that stuff in the "packet_info" structure, instead, to
  45    save memory? */
  46 typedef struct _frame_data {
  47   struct _frame_data *next; /* Next element in list */
  48   struct _frame_data *prev; /* Previous element in list */
  49   GSList      *pfd;         /* Per frame proto data */
  50   guint32      num;         /* Frame number */
  51   guint32      pkt_len;     /* Packet length */
  52   guint32      cap_len;     /* Amount actually captured */
  53   guint32      cum_bytes;   /* Cumulative bytes into the capture */
  54   gint32       rel_secs;    /* Relative seconds (yes, it can be negative) */
  55   gint32       rel_usecs;   /* Relative microseconds (yes, it can be negative) */
  56   guint32      abs_secs;    /* Absolute seconds */
  57   guint32      abs_usecs;   /* Absolute microseconds */
  58   gint32       del_secs;    /* Delta seconds (yes, it can be negative) */
  59   gint32       del_usecs;   /* Delta microseconds (yes, it can be negative) */
  60   long         file_off;    /* File offset */
  61   int          lnk_t;       /* Per-packet encapsulation/data-link type */
  62   struct {
  63         unsigned int passed_dfilter     : 1; /* 1 = display, 0 = no display */
  64         unsigned int encoding           : 2; /* Character encoding (ASCII, EBCDIC...) */
  65         unsigned int visited            : 1; /* Has this packet been visited yet? 1=Yes,0=No*/
  66         unsigned int marked             : 1; /* 1 = marked by user, 0 = normal */
  67         unsigned int ref_time           : 1; /* 1 = marked as a reference time frame, 0 = normal */
  68   } flags;
  69   void *color_filter;       /* Per-packet matching color_filter_t object */
  70 } frame_data;
  71
  72 /*
  73  * A data source.
  74  * Has a tvbuff and a name.
  75  */
  76 typedef struct {
  77   tvbuff_t *tvb;
  78   char *name;
  79 } data_source;
  80
  81 /* Utility routines used by packet*.c */
  82
  83 extern void p_add_proto_data(frame_data *, int, void *);
  84 extern void *p_get_proto_data(frame_data *, int);
  85 extern void p_rem_proto_data(frame_data *fd, int proto);
  86
  87 /* An init routine to be called by epan_init */
  88 extern void frame_data_init(void);
  89
  90 /* A cleanup routine to be called by epan_cleanup */
  91 extern void frame_data_cleanup(void);
  92
  93 #endif  /* __FRAME_DATA__ */