b2e5fa7ccc7363ea6efd51a091c06fb1c3caaac7
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 if no reply could be read from the server
40 * - a positive value if the server returned an error
41 */
42 int
43 sdb_command_print_reply(sdb_input_t *input);
45 /*
46 * sdb_command_exec:
47 * Execute the current command buffer and return the query as send to the
48 * server. The query buffer points to dynamically allocated memory which has
49 * to be free'd by the caller.
50 *
51 * The function waits for the server's reply and prints it to the standard
52 * output channel.
53 *
54 * Returns:
55 * - the query (nul-terminated string) on success
56 * - NULL else
57 */
58 char *
59 sdb_command_exec(sdb_input_t *input);
61 /*
62 * sdb_command_print_server_version:
63 * Query and print the server version.
64 */
65 void
66 sdb_command_print_server_version(sdb_input_t *input);
68 #endif /* SYSDB_COMMAND_H */
70 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */