Removed trailing whitespaces from .h and .c files using the
[obnox/wireshark/wip.git] / packet-tcp.h
1 /* packet-tcp.h
2  *
3  * $Id: packet-tcp.h,v 1.11 2002/05/05 00:57:57 guy Exp $
4  *
5  * Ethereal - Network traffic analyzer
6  * By Gerald Combs <gerald@ethereal.com>
7  * Copyright 1998 Gerald Combs
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 __PACKET_TCP_H__
25 #define __PACKET_TCP_H__
26
27 /*
28  * Private data passed from the TCP dissector to subdissectors.
29  */
30 struct tcpinfo {
31         guint32 seq;             /* Sequence number of first byte in the data */
32         gboolean is_reassembled; /* This is reassembled data. */
33         gboolean urgent;         /* TRUE if "urgent_pointer" is valid */
34         guint16 urgent_pointer;  /* Urgent pointer value for the current packet. */
35 };
36
37 /*
38  * Loop for dissecting PDUs within a TCP stream; assumes that a PDU
39  * consists of a fixed-length chunk of data that contains enough information
40  * to determine the length of the PDU, followed by rest of the PDU.
41  *
42  * The first three arguments are the arguments passed to the dissector
43  * that calls this routine.
44  *
45  * "proto_desegment" is the dissector's flag controlling whether it should
46  * desegment PDUs that cross TCP segment boundaries.
47  *
48  * "fixed_len" is the length of the fixed-length part of the PDU.
49  *
50  * "get_pdu_len()" is a routine called to get the length of the PDU from
51  * the fixed-length part of the PDU; it's passed "tvb" and "offset".
52  *
53  * "dissect_pdu()" is the routine to dissect a PDU.
54  */
55 extern void
56 tcp_dissect_pdus(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree,
57                  gboolean proto_desegment, guint fixed_len,
58                  guint (*get_pdu_len)(tvbuff_t *, int),
59                  void (*dissect_pdu)(tvbuff_t *, packet_info *, proto_tree *));
60
61 extern void decode_tcp_ports(tvbuff_t *, int, packet_info *,
62         proto_tree *, int, int);
63
64 #endif