1 /*
2 * SysDB - src/include/utils/proto.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_UTILS_PROTO_H
29 #define SDB_UTILS_PROTO_H 1
31 #include "utils/strbuf.h"
33 #include <stdint.h>
34 #include <unistd.h>
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
40 enum {
41 SDB_PROTO_SELECTIN = 0,
42 SDB_PROTO_SELECTOUT,
43 SDB_PROTO_SELECTERR,
44 };
46 /*
47 * sdb_proto_select:
48 * Wait for a file-descriptor to become ready for I/O operations of the
49 * specified type. This is a simple wrapper around the select() system call.
50 * The type argument may be any of the SDB_PROTO_SELECT* constants.
51 *
52 * Returns:
53 * - the number of file descriptors ready for I/O
54 * - a negative value on error
55 */
56 int
57 sdb_proto_select(int fd, int type);
59 ssize_t
60 sdb_proto_send(int fd, size_t msg_len, const char *msg);
62 /*
63 * sdb_proto_marshal:
64 * Encode the message into the wire format by adding an appropriate header.
65 * The encoded message is written to buf which has to be large enough to store
66 * the header (64 bits) and the entire message.
67 *
68 * Returns:
69 * - the number of bytes of the full encoded message on success (even if less
70 * than that fit into and was written to the buffer)
71 * - a negative value on error
72 */
73 ssize_t
74 sdb_proto_marshal(char *buf, size_t buf_len, uint32_t code,
75 uint32_t msg_len, const char *msg);
77 uint32_t
78 sdb_proto_get_int(sdb_strbuf_t *buf, size_t offset);
80 #ifdef __cplusplus
81 } /* extern "C" */
82 #endif
84 #endif /* ! SDB_UTILS_PROTO_H */
86 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */