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

NAME

6       remctl_new - Create a new remctl client
7

SYNOPSIS

9       #include <remctl.h>
10
11       struct remctl *remctl_new(void);
12

DESCRIPTION

14       remctl_new() creates a new remctl client.  The resulting remctl struct
15       is opaque from the perspective of the caller, but should be the first
16       argument to all subsequent calls into the remctl API.  Normally, the
17       next call after remctl_new() would be remctl_open() to connect to a
18       remote server.
19
20       The resulting struct should be freed by calling remctl_close().
21

RETURN VALUE

23       remctl_new() returns a pointer to an opaque remctl struct on success
24       and NULL on failure.  If it returns NULL, errno will be set to an
25       appropriate error code (normally ENOMEM).
26

COMPATIBILITY

28       This interface has been provided by the remctl client library since its
29       initial release in version 2.0.
30

AUTHOR

32       Russ Allbery <eagle@eyrie.org>
33

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

SEE ALSO

46       remctl_open(3), remctl_command(3), remctl_commandv(3),
47       remctl_output(3), remctl_close(3)
48
49       The current version of the remctl library and complete details of the
50       remctl protocol are available from its web page at
51       <https://www.eyrie.org/~eagle/software/remctl/>.
52
53
54
553.15                              2018-05-05                     REMCTL_NEW(3)
Impressum