tube.h

Go to the documentation of this file.

/*
 * util/tube.h - pipe service
 *
 * Copyright (c) 2008, NLnet Labs. All rights reserved.
 *
 * This software is open source.
 * 
 * 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 the NLNET LABS 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 COPYRIGHT HOLDERS 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 COPYRIGHT
 * HOLDER OR 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.
 */

 
#ifndef UTIL_TUBE_H
#define UTIL_TUBE_H
struct comm_reply;
struct comm_point;
struct comm_base;
struct tube;
struct tube_res_list;
#ifdef USE_WINSOCK
#include "util/locks.h"
#endif

typedef void tube_callback_type(struct tube*, uint8_t*, size_t, int, void*);

struct tube {
#ifndef USE_WINSOCK
    int sr;
    int sw;

    struct comm_point* listen_com;
    tube_callback_type* listen_cb;
    void* listen_arg;
    size_t cmd_read;
    uint32_t cmd_len;
    uint8_t* cmd_msg;

    struct comm_point* res_com;
    size_t res_write;
    struct tube_res_list* res_list;
    struct tube_res_list* res_last;
 
#else /* USE_WINSOCK */
    tube_callback_type* listen_cb;
    void* listen_arg;
    WSAEVENT event;
    struct ub_event* ev_listen;

    lock_basic_type res_lock;
    struct tube_res_list* res_list;
    struct tube_res_list* res_last;
#endif /* USE_WINSOCK */
};

struct tube_res_list {
    struct tube_res_list* next;
    uint8_t* buf;
    uint32_t len;
};

struct tube* tube_create(void);

void tube_delete(struct tube* tube);

int tube_write_msg(struct tube* tube, uint8_t* buf, uint32_t len, 
    int nonblock);

int tube_read_msg(struct tube* tube, uint8_t** buf, uint32_t* len, 
    int nonblock);

void tube_close_read(struct tube* tube);

void tube_close_write(struct tube* tube);

int tube_poll(struct tube* tube);

int tube_wait(struct tube* tube);

int tube_read_fd(struct tube* tube);

int tube_setup_bg_listen(struct tube* tube, struct comm_base* base,
    tube_callback_type* cb, void* arg);

void tube_remove_bg_listen(struct tube* tube);

int tube_setup_bg_write(struct tube* tube, struct comm_base* base);

void tube_remove_bg_write(struct tube* tube);
 

int tube_queue_item(struct tube* tube, uint8_t* msg, size_t len);

int tube_handle_listen(struct comm_point* c, void* arg, int error, 
    struct comm_reply* reply_info);

int tube_handle_write(struct comm_point* c, void* arg, int error, 
    struct comm_reply* reply_info);

void tube_handle_signal(int fd, short events, void* arg);
 
#endif /* UTIL_TUBE_H */