]>
sourceware.org Git - lvm2.git/blob - daemons/common/daemon-client.h
2 * Copyright (C) 2011 Red Hat, Inc. All rights reserved.
4 * This file is part of LVM2.
6 * This copyrighted material is made available to anyone wishing to use,
7 * modify, copy, or redistribute it subject to the terms and conditions
8 * of the GNU Lesser General Public License v.2.1.
10 * You should have received a copy of the GNU Lesser General Public License
11 * along with this program; if not, write to the Free Software Foundation,
12 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15 #include "libdevmapper.h" // for dm_list, needed by config.h
17 #ifndef _LVM_DAEMON_COMMON_CLIENT_H
18 #define _LVM_DAEMON_COMMON_CLIENT_H
21 int socket_fd
; /* the fd we use to talk to the daemon */
23 int protocol_version
; /* version of the protocol the daemon uses */
28 const char *path
; /* the binary of the daemon */
29 const char *socket
; /* path to the comms socket */
30 unsigned autostart
:1; /* start the daemon if not running? */
33 * If the following are not NULL/0, an attempt to talk to a daemon which
34 * uses a different protocol or version will fail.
43 * The request looks like this:
45 * arg_foo = "something"
48 * something_special = "here"
50 * knobs = [ "twiddle", "tweak" ]
53 struct dm_config_tree
*cft
;
57 int error
; /* 0 for success */
58 char *buffer
; /* textual reply */
59 struct dm_config_tree
*cft
; /* parsed reply, if available */
63 * Open the communication channel to the daemon. If the daemon is not running,
64 * it may be autostarted based on the binary path provided in the info (this
65 * will only happen if autostart is set to true). If the call fails for any
66 * reason, daemon_handle_valid(h) for the response will return false. Otherwise,
67 * the connection is good to start serving requests.
69 daemon_handle
daemon_open(daemon_info i
);
72 * Send a request to the daemon, waiting for the reply. All communication with
73 * the daemon is synchronous. The function handles the IO details and parses the
74 * response, handling common error conditions. See "daemon_reply" for details.
76 * In case the request contains a non-NULL buffer pointer, this buffer is sent
77 * *verbatim* to the server. In this case, the cft pointer may be NULL (but will
78 * be ignored even if non-NULL). If the buffer is NULL, the cft is required to
79 * be a valid pointer, and is used to build up the request.
81 daemon_reply
daemon_send(daemon_handle h
, daemon_request r
);
84 * A simple interface to daemon_send. This function just takes the command id
85 * and possibly a list of parameters (of the form "name = %?", "value"). The
86 * type (string, integer) of the value is indicated by a character substituted
87 * for ? in %?: d for integer, s for string.
89 daemon_reply
daemon_send_simple(daemon_handle h
, const char *id
, ...);
91 void daemon_reply_destroy(daemon_reply r
);
93 static inline int daemon_reply_int(daemon_reply r
, const char *path
, int def
) {
94 return dm_config_find_int(r
.cft
->root
, path
, def
);
97 static inline const char *daemon_reply_str(daemon_reply r
, const char *path
, const char *def
) {
98 return dm_config_find_str(r
.cft
->root
, path
, def
);
102 /* Shut down the communication to the daemon. Compulsory. */
103 void daemon_close(daemon_handle h
);
This page took 0.040885 seconds and 5 git commands to generate.