1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
=for stopwords
remctl const NOOP Allbery SPDX-License-Identifier FSFAP
=head1 NAME
remctl_noop - Send a NOOP message to a remctl server
=head1 SYNOPSIS
#include <remctl.h>
int B<remctl_noop>(struct remctl *I<r>);
=head1 DESCRIPTION
remctl_noop() sends a NOOP message to a remctl server and reads the
expected NOOP response. This is primarily used to keep a connection to a
remctl server alive, such as through a firewall with a session timeout,
while waiting to issue further commands.
The NOOP message requires protocol version 3 support in the server, so the
caller should be prepared for this function to fail, indicating that the
connection could not be kept alive and possibly that it was closed by the
server. In this case, the client will need to explicitly reopen the
connection with remctl_open().
=head1 RETURN VALUE
remctl_noop() returns true on success and false on failure. On failure,
the caller should call remctl_error() to retrieve the error message. In
addition to network errors, this function may fail if the server doesn't
support protocol version 3.
=head1 COMPATIBILITY
This interface was added in version 3.0.
=head1 AUTHOR
Russ Allbery <eagle@eyrie.org>
=head1 COPYRIGHT AND LICENSE
Copyright 2011, 2014 The Board of Trustees of the Leland Stanford Junior
University
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
remctl_new(3), remctl_open(3), remctl_command(3), remctl_error(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
|
