1 /*
2 * SysDB - src/include/client/sock.h
3 * Copyright (C) 2013 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 #ifndef SDB_CLIENT_SOCK_H
29 #define SDB_CLIENT_SOCK_H 1
31 #include "core/object.h"
32 #include "core/data.h"
34 #include "utils/strbuf.h"
36 #include <sys/socket.h>
38 #include <stddef.h>
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
44 struct sdb_client;
45 typedef struct sdb_client sdb_client_t;
47 /*
48 * sdb_client_create:
49 * Allocates and initializes a client object to connect to the specified
50 * address.
51 *
52 * Returns:
53 * - a new client object on success
54 * - NULL in case of an error
55 */
56 sdb_client_t *
57 sdb_client_create(const char *address);
59 /*
60 * sdb_client_destroy:
61 * Destroyes the client connection and deallocates the client object.
62 */
63 void
64 sdb_client_destroy(sdb_client_t *client);
66 /*
67 * sdb_client_connect:
68 * Connect to the client's address.
69 *
70 * Returns:
71 * - 0 on success
72 * - a negative value else
73 */
74 int
75 sdb_client_connect(sdb_client_t *client);
77 /*
78 * sdb_client_close:
79 * Close the client connection.
80 */
81 void
82 sdb_client_close(sdb_client_t *client);
84 /*
85 * sdb_client_send:
86 * Send the specified command and accompanying data to through the client
87 * connection.
88 *
89 * Returns:
90 * - 0 on success
91 * - a negative value else.
92 */
93 ssize_t
94 sdb_client_send(sdb_client_t *client,
95 uint32_t cmd, uint32_t data_len, const char *data);
97 /*
98 * sdb_client_recv:
99 * Receive data from the connection. All data is written to the specified
100 * buffer. If specified, the returned status code is written to the memory
101 * location pointed to by 'code'. In case of an error or an incomplete
102 * command, the status code is set to UINT32_MAX. The returned data does not
103 * include the status code and message len as received from the remote side
104 * but only the data associated with the message.
105 *
106 * Returns:
107 * - the number of bytes read
108 * (may be zero if the message did not include any data)
109 * - a negative value on error
110 */
111 ssize_t
112 sdb_client_recv(sdb_client_t *client,
113 uint32_t *code, sdb_strbuf_t *buf);
115 #ifdef __cplusplus
116 } /* extern "C" */
117 #endif
119 #endif /* ! SDB_CLIENT_SOCK_H */
121 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */