1 /*
2 * SysDB - src/tools/sysdb/command.h
3 * Copyright (C) 2014 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 #include "tools/sysdb/input.h"
30 #ifndef SYSDB_COMMAND_H
31 #define SYSDB_COMMAND_H 1
33 /*
34 * sdb_command_print_reply:
35 * Read a reply from the server and print it to the standard output channel.
36 *
37 * Returns:
38 * - 0 on success
39 * - a negative value else
40 */
41 int
42 sdb_command_print_reply(sdb_client_t *client);
44 /*
45 * sdb_command_exec:
46 * Execute the current command buffer and return the query as send to the
47 * server. The query buffer points to dynamically allocated memory which has
48 * to be free'd by the caller.
49 *
50 * The function waits for the server's reply and prints it to the standard
51 * output channel.
52 *
53 * Returns:
54 * - the query (nul-terminated string) on success
55 * - NULL else
56 */
57 char *
58 sdb_command_exec(sdb_input_t *input);
60 #endif /* SYSDB_COMMAND_H */
62 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */