remctl_close(3) [debian man page]

REMCTL_CLOSE(3) 					     remctl Library Reference						   REMCTL_CLOSE(3)

NAME

       remctl_close - Close a remctl connection and free the client object

SYNOPSIS

       #include <remctl.h>

       void remctl_close(struct remctl *r);

DESCRIPTION

       remctl_close() cleanly closes any connection to a remote server created via remctl_open() for the given client object and then frees the
       object created by remctl_new().	It should be called when the caller is finished with a remctl client object to avoid resource leaks.
       Following the call to remctl_close(), the r pointer to the remctl client object is no longer valid.

       remctl_close() is always successful, even if it is unable to send a clean protocol quit command to the remote server.

SEE ALSO

       remctl_new(3), remctl_open(3)

       The current version of the remctl library and complete details of the remctl protocol are available from its web page at
       <http://www.eyrie.org/~eagle/software/remctl/>.

AUTHOR

       Russ Allbery <rra@stanford.edu>

COPYRIGHT AND LICENSE

       Copyright 2007, 2009 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.

3.2								    2012-06-19							   REMCTL_CLOSE(3)

REMCTL_COMMAND(3)					     remctl Library Reference						 REMCTL_COMMAND(3)

NAME

       remctl_command, remctl_commandv - Send a command to a remctl server

SYNOPSIS

       #include <remctl.h>

       int remctl_command(struct remctl *r, const char **command);

       #include <sys/uio.h>

       int remctl_commandv(struct remctl *r, const struct iovec *iov,
			   size_t count);

DESCRIPTION

       remctl_command() and remctl_commandv() send a command to a remote remctl server.  The remctl client object 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 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.

       After calling one of these functions, call remctl_output() to get the results of the command.

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.

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
       <http://www.eyrie.org/~eagle/software/remctl/>.

AUTHOR

       Russ Allbery <rra@stanford.edu>

COPYRIGHT AND LICENSE

       Copyright 2007, 2009 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.

3.2								    2012-06-19							 REMCTL_COMMAND(3)