2004-11-27 16:20:21 +03:00
|
|
|
/*
|
|
|
|
* pinger.c: centralised module that deals with sending TS_PING
|
|
|
|
* keepalives, to avoid replicating this code in multiple backends.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "putty.h"
|
|
|
|
|
|
|
|
struct pinger_tag {
|
|
|
|
int interval;
|
|
|
|
int pending;
|
2016-04-01 15:27:03 +03:00
|
|
|
unsigned long when_set, next;
|
2004-11-27 16:20:21 +03:00
|
|
|
Backend *back;
|
|
|
|
void *backhandle;
|
|
|
|
};
|
|
|
|
|
|
|
|
static void pinger_schedule(Pinger pinger);
|
|
|
|
|
2012-09-19 01:42:48 +04:00
|
|
|
static void pinger_timer(void *ctx, unsigned long now)
|
2004-11-27 16:20:21 +03:00
|
|
|
{
|
|
|
|
Pinger pinger = (Pinger)ctx;
|
|
|
|
|
2012-09-19 01:42:48 +04:00
|
|
|
if (pinger->pending && now == pinger->next) {
|
2004-11-27 16:20:21 +03:00
|
|
|
pinger->back->special(pinger->backhandle, TS_PING);
|
|
|
|
pinger->pending = FALSE;
|
|
|
|
pinger_schedule(pinger);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static void pinger_schedule(Pinger pinger)
|
|
|
|
{
|
2016-04-01 15:27:03 +03:00
|
|
|
unsigned long next;
|
2004-11-27 16:20:21 +03:00
|
|
|
|
|
|
|
if (!pinger->interval) {
|
|
|
|
pinger->pending = FALSE; /* cancel any pending ping */
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
next = schedule_timer(pinger->interval * TICKSPERSEC,
|
|
|
|
pinger_timer, pinger);
|
2016-04-01 15:27:03 +03:00
|
|
|
if (!pinger->pending ||
|
|
|
|
(next - pinger->when_set) < (pinger->next - pinger->when_set)) {
|
2004-11-27 16:20:21 +03:00
|
|
|
pinger->next = next;
|
2016-04-01 15:27:03 +03:00
|
|
|
pinger->when_set = timing_last_clock();
|
2004-11-27 16:20:21 +03:00
|
|
|
pinger->pending = TRUE;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
Pinger pinger_new(Conf *conf, Backend *back, void *backhandle)
|
2004-11-27 16:20:21 +03:00
|
|
|
{
|
|
|
|
Pinger pinger = snew(struct pinger_tag);
|
|
|
|
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
pinger->interval = conf_get_int(conf, CONF_ping_interval);
|
2004-11-27 16:20:21 +03:00
|
|
|
pinger->pending = FALSE;
|
|
|
|
pinger->back = back;
|
|
|
|
pinger->backhandle = backhandle;
|
|
|
|
pinger_schedule(pinger);
|
|
|
|
|
|
|
|
return pinger;
|
|
|
|
}
|
|
|
|
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
void pinger_reconfig(Pinger pinger, Conf *oldconf, Conf *newconf)
|
2004-11-27 16:20:21 +03:00
|
|
|
{
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
int newinterval = conf_get_int(newconf, CONF_ping_interval);
|
|
|
|
if (conf_get_int(oldconf, CONF_ping_interval) != newinterval) {
|
|
|
|
pinger->interval = newinterval;
|
2004-11-27 16:20:21 +03:00
|
|
|
pinger_schedule(pinger);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void pinger_free(Pinger pinger)
|
|
|
|
{
|
|
|
|
expire_timer_context(pinger);
|
|
|
|
sfree(pinger);
|
|
|
|
}
|