remctl_noop(3)

1REMCTL_NOOP(3)             remctl Library Reference             REMCTL_NOOP(3)
2
3
4

NAME

6       remctl_noop - Send a NOOP message to a remctl server
7

SYNOPSIS

9       #include <remctl.h>
10
11       int remctl_noop(struct remctl *r);
12

DESCRIPTION

14       remctl_noop() sends a NOOP message to a remctl server and reads the
15       expected NOOP response.  This is primarily used to keep a connection to
16       a remctl server alive, such as through a firewall with a session
17       timeout, while waiting to issue further commands.
18
19       The NOOP message requires protocol version 3 support in the server, so
20       the caller should be prepared for this function to fail, indicating
21       that the connection could not be kept alive and possibly that it was
22       closed by the server.  In this case, the client will need to explicitly
23       reopen the connection with remctl_open().
24

RETURN VALUE

26       remctl_noop() returns true on success and false on failure.  On
27       failure, the caller should call remctl_error() to retrieve the error
28       message.  In addition to network errors, this function may fail if the
29       server doesn't support protocol version 3.
30

COMPATIBILITY

32       This interface was added in version 3.0.
33

AUTHOR

35       Russ Allbery <eagle@eyrie.org>
36

COPYRIGHT AND LICENSE

38       Copyright 2011, 2014 The Board of Trustees of the Leland Stanford
39       Junior University
40
41       Copying and distribution of this file, with or without modification,
42       are permitted in any medium without royalty provided the copyright
43       notice and this notice are preserved.  This file is offered as-is,
44       without any warranty.
45
46       SPDX-License-Identifier: FSFAP
47