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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
=for stopwords
remctl const iovec NUL-terminated argv Allbery SPDX-License-Identifier
FSFAP
=head1 NAME
remctl_command, remctl_commandv - Send a command to a remctl server
=head1 SYNOPSIS
#include <remctl.h>
int B<remctl_command>(struct remctl *I<r>, const char **I<command>);
#include <sys/uio.h>
int B<remctl_commandv>(struct remctl *I<r>, const struct iovec *I<iov>,
size_t I<count>);
=head1 DESCRIPTION
remctl_command() and remctl_commandv() send a command to a remote remctl
server. The remctl client object I<r>, created with remctl_new(), should
have previously been passed to remctl_open() to open a connection to the
server.
remctl_command() takes the command as a NULL-terminated array of
NUL-terminated strings (the same layout as an argv array). This function
is most convenient when passing simple text commands.
remctl_commandv() takes the command as an array of iovec structs of length
I<count>. This function is most convenient when passing arbitrary data to
the command, since the iovec struct takes a pointer and a length for each
chunk of data. See writev(2) for the layout of the iovec struct.
To control the network timeout for sending the command, see the
L<remctl_set_timeout(3)> function.
After calling one of these functions, call remctl_output() to get the
results of the command.
=head1 RETURN VALUE
remctl_command() and remctl_commandv() return true on success and false on
failure. On failure, the caller should call remctl_error() to retrieve
the error message.
=head1 COMPATIBILITY
These interfaces have been provided by the remctl client library since its
initial release in version 2.0.
=head1 AUTHOR
Russ Allbery <eagle@eyrie.org>
=head1 COPYRIGHT AND LICENSE
Copyright 2007, 2009, 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_output(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
|
