src/fifo.h
branchnew-lib-errors
changeset 219 cefec18b8268
parent 218 5229a5d098b2
equal deleted inserted replaced
218:5229a5d098b2 219:cefec18b8268
     1 #ifndef FIFO_H
       
     2 #define FIFO_H
       
     3 
       
     4 #include "transport.h"
       
     5 
       
     6 #include <event2/event.h>
       
     7 
       
     8 /**
       
     9  * A read-only transport based on a FIFO, this provides nonblocking read operations by re-opening the FIFO on EOF.
       
    10  *
       
    11  * The transport will be ready for use right away, transport_callbacks::on_connect will never be called.
       
    12  *
       
    13  * @param transport_info the setup info required to create the transport
       
    14  * @param transport_ptr returned transport
       
    15  * @param path the path to the filesystem fifo object
       
    16  * @param err returned error info
       
    17  */
       
    18 err_t fifo_open_read (struct transport_info *transport_info, transport_t **transport_ptr, struct event_base *ev_base,
       
    19         const char *path, error_t *err);
       
    20 
       
    21 
       
    22 #endif