rework and comment out some debugging prints
[dana/openbox.git] / openbox / ping.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    client.h for the Openbox window manager
4    Copyright (c) 2006        Mikael Magnusson
5    Copyright (c) 2003-2008   Dana Jansens
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #include "ping.h"
21 #include "client.h"
22 #include "prop.h"
23 #include "event.h"
24 #include "mainloop.h"
25 #include "openbox.h"
26
27 typedef struct _ObPingTarget
28 {
29     ObClient *client;
30     ObPingEventHandler h;
31     Time sent;
32     gint waiting;
33 } ObPingTarget;
34
35 static GSList *ping_targets = NULL;
36 static gboolean active = FALSE;
37
38 #define PING_TIMEOUT (G_USEC_PER_SEC * 3)
39 /*! Warn the user after this many PING_TIMEOUT intervals */
40 #define PING_TIMEOUT_WARN 3
41
42 static void ping_send(ObPingTarget *t);
43 static void ping_end(ObClient *client, gpointer data);
44 static gboolean ping_timeout(gpointer data);
45
46 void ping_start(struct _ObClient *client, ObPingEventHandler h)
47 {
48     GSList *it;
49     ObPingTarget *t;
50
51     g_assert(client->ping == TRUE);
52
53     /* make sure we're not already pinging it */
54     for (it = ping_targets; it != NULL; it = g_slist_next(it)) {
55         t = it->data;
56         if (t->client == client) return;
57     }
58
59     t = g_new(ObPingTarget, 1);
60     t->client = client;
61     t->h = h;
62     t->waiting = 1; /* first wait for a reply */
63
64     ping_send(t);
65     ping_targets = g_slist_prepend(ping_targets, t);
66     ob_main_loop_timeout_add(ob_main_loop, PING_TIMEOUT, ping_timeout,
67                              t, NULL, NULL);
68
69     if (!active) {
70         active = TRUE;
71         /* listen for the client to disappear */
72         client_add_destroy_notify(ping_end, NULL);
73     }
74 }
75
76 void ping_stop(struct _ObClient *c)
77 {
78     ping_end(c, NULL);
79 }
80
81 void ping_got_pong(Time timestamp)
82 {
83     GSList *it;
84     ObPingTarget *t;
85
86     /* make sure we're not already pinging it */
87     for (it = ping_targets; it != NULL; it = g_slist_next(it)) {
88         t = it->data;
89         if (t->sent == timestamp) {
90             /*ob_debug("PONG: '%s' (timestamp %lu)\n", t->client->title,
91                      t->sent);*/
92             if (t->waiting > PING_TIMEOUT_WARN) {
93                 /* we had notified that they weren't responding, so now we
94                    need to notify that they are again */
95                 t->h(t->client, FALSE);
96             }
97             t->waiting = 0; /* not waiting for a reply anymore */
98             break;
99         }
100     }
101
102     if (it == NULL)
103         ob_debug("Got PONG with timestamp %lu but not waiting for one\n",
104                  timestamp);
105 }
106
107 static void ping_send(ObPingTarget *t)
108 {
109     t->sent = event_get_server_time();
110     /*ob_debug("PING: '%s' (timestamp %lu)\n", t->client->title, t->sent);*/
111     ob_debug("PINGing client %s at %lu\n", t->client->title, t->sent);
112     PROP_MSG_TO(t->client->window, t->client->window, wm_protocols,
113                 prop_atoms.net_wm_ping, t->sent, t->client->window, 0, 0,
114                 NoEventMask);
115 }
116
117 static gboolean ping_timeout(gpointer data)
118 {
119     ObPingTarget *t = data;
120
121     if (t->waiting == 0) { /* got a reply already */
122         /* send another ping to make sure it's still alive */
123         ping_send(t);
124     }
125
126     if (t->waiting == PING_TIMEOUT_WARN)
127         t->h(t->client, TRUE); /* notify that the client isn't responding */
128
129     ++t->waiting;
130
131     return TRUE; /* repeat */
132 }
133
134 static void ping_end(ObClient *client, gpointer data)
135 {
136     GSList *it;
137     ObPingTarget *t;
138
139     for (it = ping_targets; it != NULL; it = g_slist_next(it)) {
140         t = it->data;
141         if (t->client == client) {
142             ping_targets = g_slist_remove_link(ping_targets, it);
143             ob_main_loop_timeout_remove_data(ob_main_loop, ping_timeout, t,
144                                              FALSE);
145             g_free(t);
146             break;
147         }
148     }
149
150     /* stop listening if we're not waiting for any more pings */
151     if (!ping_targets) {
152         active = TRUE;
153         client_remove_destroy_notify(ping_end);
154     }    
155 }