src/fifo.h
author Tero Marttila <terom@fixme.fi>
Thu, 28 May 2009 00:35:02 +0300
branchnew-lib-errors
changeset 218 5229a5d098b2
parent 157 1e5674d0eec4
permissions -rw-r--r--
some of spbot and lib compiles
#ifndef FIFO_H
#define FIFO_H

#include "transport.h"

#include <event2/event.h>

/**
 * A read-only transport based on a FIFO, this provides nonblocking read operations by re-opening the FIFO on EOF.
 *
 * The transport will be ready for use right away, transport_callbacks::on_connect will never be called.
 *
 * @param transport_info the setup info required to create the transport
 * @param transport_ptr returned transport
 * @param path the path to the filesystem fifo object
 * @param err returned error info
 */
err_t fifo_open_read (struct transport_info *transport_info, transport_t **transport_ptr, struct event_base *ev_base,
        const char *path, error_t *err);


#endif