badvpn/flow/PacketPassFifoQueue.h

/**
 * @file PacketPassFifoQueue.h
 * @author Ambroz Bizjak <ambrop7@gmail.com>
 * 
 * @section LICENSE
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. Neither the name of the author 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 AUTHOR 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 BADVPN_PACKETPASSFIFOQUEUE_H
#define BADVPN_PACKETPASSFIFOQUEUE_H

#include <misc/debugcounter.h>
#include <structure/LinkedList1.h>
#include <base/DebugObject.h>
#include <flow/PacketPassInterface.h>

typedef void (*PacketPassFifoQueue_handler_busy) (void *user);

struct PacketPassFifoQueueFlow_s;

typedef struct {
    PacketPassInterface *output;
    BPendingGroup *pg;
    LinkedList1 waiting_flows_list;
    struct PacketPassFifoQueueFlow_s *sending_flow;
    BPending schedule_job;
    int freeing;
    DebugCounter d_flows_ctr;
    DebugObject d_obj;
} PacketPassFifoQueue;

typedef struct PacketPassFifoQueueFlow_s {
    PacketPassFifoQueue *queue;
    PacketPassInterface input;
    int is_waiting;
    LinkedList1Node waiting_flows_list_node;
    uint8_t *waiting_data;
    int waiting_len;
    PacketPassFifoQueue_handler_busy handler_busy;
    void *user;
    DebugObject d_obj;
} PacketPassFifoQueueFlow;

void PacketPassFifoQueue_Init (PacketPassFifoQueue *o, PacketPassInterface *output, BPendingGroup *pg);
void PacketPassFifoQueue_Free (PacketPassFifoQueue *o);
void PacketPassFifoQueue_PrepareFree (PacketPassFifoQueue *o);

void PacketPassFifoQueueFlow_Init (PacketPassFifoQueueFlow *o, PacketPassFifoQueue *queue);
void PacketPassFifoQueueFlow_Free (PacketPassFifoQueueFlow *o);
void PacketPassFifoQueueFlow_AssertFree (PacketPassFifoQueueFlow *o);
int PacketPassFifoQueueFlow_IsBusy (PacketPassFifoQueueFlow *o);
void PacketPassFifoQueueFlow_SetBusyHandler (PacketPassFifoQueueFlow *o, PacketPassFifoQueue_handler_busy handler_busy, void *user);
PacketPassInterface * PacketPassFifoQueueFlow_GetInput (PacketPassFifoQueueFlow *o);

#endif