remove dependencies to pcap.h, so getting an idea what needs to be done by dumpcap...
[obnox/wireshark/wip.git] / capture_sync.h
1 /* capture_sync.h
2  * Synchronisation between Ethereal capture parent and child instances
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
26 /** @file
27  *  
28  *  Sync mode capture (internal interface).
29  *
30  *  Will start a new Ethereal child instance which will do the actual capture 
31  *  work.
32  */
33
34 #ifndef __CAPTURE_SYNC_H__
35 #define __CAPTURE_SYNC_H__
36
37
38 /* Size of buffer to hold decimal representation of
39    signed/unsigned 64-bit int */
40 #define SP_DECISIZE 20
41
42 /*
43  * Indications sent out on the sync pipe (from child to parent).
44  */
45 #define SP_FILE         'F'     /* the name of the recently opened file */
46 #define SP_ERROR_MSG    'E'     /* error message */
47 #define SP_PACKET_COUNT 'P'     /* count of packets captured since last message */
48 #define SP_DROPS        'D'     /* count of packets dropped in capture */
49 /*
50  * Win32 only: Indications sent out on the signal pipe (from parent to child)
51  * (UNIX-like sends signals for this)
52  */
53 #define SP_QUIT         'Q'     /* "gracefully" capture quit message (SIGUSR1) */
54
55
56
57 /** 
58  * Start a new capture session.
59  *  Create a capture child which is doing the real capture work.
60  *  The various capture_input_... functions will be called, if something had 
61  *  happened.
62  *
63  *  Most of the parameters are passed through the global capture_opts.
64  *
65  *  @param capture_opts the options
66  *  @return             TRUE if a capture could be started, FALSE if not
67  */
68 extern gboolean 
69 sync_pipe_start(capture_options *capture_opts);
70
71 /** User wants to stop capturing, gracefully close the capture child */
72 extern void
73 sync_pipe_stop(capture_options *capture_opts);
74
75 /** User wants to stop the program, just kill the child as soon as possible */
76 extern void
77 sync_pipe_kill(capture_options *capture_opts);
78
79
80 /** the child has opened a new capture file, notify the parent */
81 extern void
82 sync_pipe_filename_to_parent(const char *filename);
83
84 /** the child captured some new packets, notify the parent */
85 extern void
86 sync_pipe_packet_count_to_parent(int packet_count);
87
88 /** the child stopped capturing, notify the parent */
89 extern void
90 sync_pipe_drops_to_parent(int drops);
91
92 /** the child encountered an error, notify the parent */
93 extern void 
94 sync_pipe_errmsg_to_parent(const char *errmsg);
95
96
97 /** does the parent signalled the child to stop */
98 #ifdef _WIN32
99 extern gboolean
100 signal_pipe_check_running(void);
101 #endif
102
103 #endif /* capture_sync.h */