/* This file is part of the YAZ toolkit.
 * Copyright (C) 1995-2013 Index Data.
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Index Data nor the names of its contributors
 *       may be used to endorse or promote products derived from this
 *       software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * \file spipe.h
 * \brief socket-pipe header
 */
#ifndef YAZ_SPIPE_H
#define YAZ_SPIPE_H

#include <stddef.h>
#include <time.h>
#include <yaz/yconfig.h>
#include <yaz/wrbuf.h>

YAZ_BEGIN_CDECL

/** \brief YAZ socket pipe opaque pointer */
typedef struct yaz_spipe *yaz_spipe_t;

/** \brief create socket pipe
    \param port_to_use port that we temporarily bind to
    \param err_msg error message reference (0 if not to be set)
    \returns 0 on failure; != 0 on success
 */
YAZ_EXPORT yaz_spipe_t yaz_spipe_create(int port_to_use, WRBUF *err_msg);

/** \brief destroys socket pipe
    \param p socket pipe pointer
 */
YAZ_EXPORT void yaz_spipe_destroy(yaz_spipe_t p);

/** \brief returns reading socket
    \param p socket pipe pointer
 */
YAZ_EXPORT int yaz_spipe_get_read_fd(yaz_spipe_t p);

/** \brief returns writing socket
    \param p socket pipe pointer
 */
YAZ_EXPORT int yaz_spipe_get_write_fd(yaz_spipe_t p);

YAZ_END_CDECL

#endif
/*
 * Local variables:
 * c-basic-offset: 4
 * c-file-style: "Stroustrup"
 * indent-tabs-mode: nil
 * End:
 * vim: shiftwidth=4 tabstop=8 expandtab
 */

