src/include/client/sock.h

   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  */
  27
  28 #ifndef SDB_CLIENT_SOCK_H
  29 #define SDB_CLIENT_SOCK_H 1
  30
  31 #include "core/object.h"
  32 #include "core/data.h"
  33 #include "frontend/proto.h"
  34 #include "utils/strbuf.h"
  35
  36 #include <sys/socket.h>
  37
  38 #include <stdbool.h>
  39 #include <stddef.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 struct sdb_client;
  46 typedef struct sdb_client sdb_client_t;
  47
  48 /*
  49  * sdb_client_create:
  50  * Allocates and initializes a client object to connect to the specified
  51  * address.
  52  *
  53  * Returns:
  54  *  - a new client object on success
  55  *  - NULL in case of an error
  56  */
  57 sdb_client_t *
  58 sdb_client_create(const char *address);
  59
  60 /*
  61  * sdb_client_destroy:
  62  * Destroyes the client connection and deallocates the client object.
  63  */
  64 void
  65 sdb_client_destroy(sdb_client_t *client);
  66
  67 /*
  68  * sdb_client_connect:
  69  * Connect to the client's address using the specified username.
  70  *
  71  * Returns:
  72  *  - 0 on success
  73  *  - a negative value else
  74  */
  75 int
  76 sdb_client_connect(sdb_client_t *client, const char *username);
  77
  78 /*
  79  * sdb_client_sockfd:
  80  * Return the client socket's file descriptor.
  81  */
  82 int
  83 sdb_client_sockfd(sdb_client_t *client);
  84
  85 /*
  86  * sdb_client_shutdown:
  87  * Shut down the client's send and/or receive operations.
  88  * See shutdown(3) for details.
  89  */
  90 int
  91 sdb_client_shutdown(sdb_client_t *client, int how);
  92
  93 /*
  94  * sdb_client_close:
  95  * Close the client connection.
  96  */
  97 void
  98 sdb_client_close(sdb_client_t *client);
  99
 100 /*
 101  * sdb_client_send:
 102  * Send the specified command and accompanying data to through the client
 103  * connection.
 104  *
 105  * Returns:
 106  *  - the number of bytes send
 107  *  - a negative value else.
 108  */
 109 ssize_t
 110 sdb_client_send(sdb_client_t *client,
 111                 uint32_t cmd, uint32_t data_len, const char *data);
 112
 113 /*
 114  * sdb_client_recv:
 115  * Receive data from the connection. All data is written to the specified
 116  * buffer. If specified, the returned status code is written to the memory
 117  * location pointed to by 'code'. In case of an error or an incomplete
 118  * command, the status code is set to UINT32_MAX. The returned data does not
 119  * include the status code and message len as received from the remote side
 120  * but only the data associated with the message.
 121  *
 122  * Returns:
 123  *  - the number of bytes read
 124  *    (may be zero if the message did not include any data)
 125  *  - a negative value on error
 126  */
 127 ssize_t
 128 sdb_client_recv(sdb_client_t *client,
 129                 uint32_t *code, sdb_strbuf_t *buf);
 130
 131 /*
 132  * sdb_client_eof:
 133  * Returns true if end of file on the client connection was reached, that is,
 134  * if the remote side closed the connection.
 135  */
 136 bool
 137 sdb_client_eof(sdb_client_t *client);
 138
 139 #ifdef __cplusplus
 140 } /* extern "C" */
 141 #endif
 142
 143 #endif /* ! SDB_CLIENT_SOCK_H */
 144
 145 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 146