src/include/utils/proto.h

   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  */
  27
  28 #ifndef SDB_UTILS_PROTO_H
  29 #define SDB_UTILS_PROTO_H 1
  30
  31 #include "core/data.h"
  32
  33 #include <stdint.h>
  34 #include <unistd.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /*
  41  * sdb_proto_marshal:
  42  * Encode the message into the wire format by adding an appropriate header.
  43  * The encoded message is written to buf which has to be large enough to store
  44  * the header (64 bits) and the entire message.
  45  *
  46  * Returns:
  47  *  - The number of bytes of the full encoded message on success. The function
  48  *    does not write more than 'buf_len' bytes. If the output was truncated
  49  *    then the return value is the number of bytes which would have been
  50  *    written if enough space had been available.
  51  *  - a negative value on error
  52  */
  53 ssize_t
  54 sdb_proto_marshal(char *buf, size_t buf_len, uint32_t code,
  55                 uint32_t msg_len, const char *msg);
  56
  57 /*
  58  * sdb_proto_marshal_data:
  59  * Encode a datum into the wire format and write it to buf.
  60  *
  61  * Returns:
  62  *  - The number of bytes of the full encoded datum on success. The function
  63  *    does not write more than 'buf_len' bytes. If the output was truncated
  64  *    then the return value is the number of bytes which would have been
  65  *    written if enough space had been available.
  66  *  - a negative value else
  67  */
  68 ssize_t
  69 sdb_proto_marshal_data(char *buf, size_t buf_len, sdb_data_t *datum);
  70
  71 /*
  72  * sdb_proto_unmarshal_header:
  73  * Read and decode a message header from the specified string.
  74  *
  75  * Returns:
  76  *  - 0 on success
  77  *  - a negative value else
  78  */
  79 int
  80 sdb_proto_unmarshal_header(const char *buf, size_t buf_len,
  81                 uint32_t *code, uint32_t *msg_len);
  82
  83 /*
  84  * sdb_proto_unmarshal_int:
  85  * Read and decode an integer from the specified string.
  86  */
  87 uint32_t
  88 sdb_proto_unmarshal_int(const char *buf, size_t buf_len);
  89
  90 #ifdef __cplusplus
  91 } /* extern "C" */
  92 #endif
  93
  94 #endif /* ! SDB_UTILS_PROTO_H */
  95
  96 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
  97