include/yaz/spipe.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2010 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file spipe.h
  30  * \brief socket-pipe header
  31  */
  32 #ifndef YAZ_SPIPE_H
  33 #define YAZ_SPIPE_H
  34
  35 #include <stddef.h>
  36 #include <time.h>
  37 #include <yaz/yconfig.h>
  38 #include <yaz/wrbuf.h>
  39
  40 YAZ_BEGIN_CDECL
  41
  42 /** \brief YAZ socket pipe opaque pointer */
  43 typedef struct yaz_spipe *yaz_spipe_t;
  44
  45 /** \brief create socket pipe
  46     \param port_to_use port that we temporarily bind to
  47     \param err_msg error message reference (0 if not to be set)
  48     \returns 0 on failure; != 0 on success
  49  */
  50 YAZ_EXPORT yaz_spipe_t yaz_spipe_create(int port_to_use, WRBUF *err_msg);
  51
  52 /** \brief destroys socket pipe
  53     \param p socket pipe pointer
  54  */
  55 YAZ_EXPORT void yaz_spipe_destroy(yaz_spipe_t p);
  56
  57 /** \brief returns reading socket
  58     \param p socket pipe pointer
  59  */
  60 YAZ_EXPORT int yaz_spipe_get_read_fd(yaz_spipe_t p);
  61
  62 /** \brief returns writing socket
  63     \param p socket pipe pointer
  64  */
  65 YAZ_EXPORT int yaz_spipe_get_write_fd(yaz_spipe_t p);
  66
  67 YAZ_END_CDECL
  68
  69 #endif
  70 /*
  71  * Local variables:
  72  * c-basic-offset: 4
  73  * c-file-style: "Stroustrup"
  74  * indent-tabs-mode: nil
  75  * End:
  76  * vim: shiftwidth=4 tabstop=8 expandtab
  77  */
  78