src/include/utils/unixsock.h

   1 /*
   2  * syscollector - src/include/utils/unixsock.h
   3  * Copyright (C) 2012 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 SC_UTILS_UNIXSOCK_H
  29 #define SC_UTILS_UNIXSOCK_H 1
  30
  31 #include <sys/socket.h>
  32
  33 #include <stddef.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 struct sc_unixsock_client;
  40 typedef struct sc_unixsock_client sc_unixsock_client_t;
  41
  42 sc_unixsock_client_t *
  43 sc_unixsock_client_create(const char *path);
  44
  45 int
  46 sc_unixsock_client_connect(sc_unixsock_client_t *client);
  47
  48 int
  49 sc_unixsock_client_send(sc_unixsock_client_t *client, const char *msg);
  50
  51 char *
  52 sc_unixsock_client_recv(sc_unixsock_client_t *client, char *buffer, size_t buflen);
  53
  54 /*
  55  * sc_unixsock_client_shutdown:
  56  * Shut down the client's send and/or receive operations. If appropriate, the
  57  * client will automatically re-connect on the next send / receive operation
  58  * after that.
  59  *
  60  * See shutdown(3) for details.
  61  */
  62 int
  63 sc_unixsock_client_shutdown(sc_unixsock_client_t *client, int how);
  64
  65 void
  66 sc_unixsock_client_destroy(sc_unixsock_client_t *client);
  67
  68 const char *
  69 sc_unixsock_client_path(sc_unixsock_client_t *client);
  70
  71 #ifdef __cplusplus
  72 } /* extern "C" */
  73 #endif
  74
  75 #endif /* ! SC_UTILS_UNIXSOCK_H */
  76
  77 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
  78