fifo.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef GUAC_FIFO_H
#define GUAC_FIFO_H
 
#include "fifo-constants.h"
#include "fifo-types.h"
#include "flag.h"
 
#include <stddef.h>
#include <sys/types.h>


 
struct guac_fifo {

    guac_flag state;

    size_t max_items;

    size_t item_size;

    size_t head;

    size_t item_count;

    ssize_t items_offset;
 
};

void guac_fifo_init(guac_fifo* fifo, void* items,
        size_t max_items, size_t item_size);

void guac_fifo_destroy(guac_fifo* fifo);

void guac_fifo_invalidate(guac_fifo* fifo);

int guac_fifo_is_valid(guac_fifo* fifo);

void guac_fifo_lock(guac_fifo* fifo);

void guac_fifo_unlock(guac_fifo* fifo);

int guac_fifo_enqueue(guac_fifo* fifo, const void* item);

int guac_fifo_enqueue_and_lock(guac_fifo* fifo, const void* item);

int guac_fifo_dequeue(guac_fifo* fifo, void* item);

int guac_fifo_dequeue_and_lock(guac_fifo* fifo, void* item);

int guac_fifo_timed_dequeue(guac_fifo* fifo,
        void* item, int msec_timeout);

int guac_fifo_timed_dequeue_and_lock(guac_fifo* fifo,
        void* item, int msec_timeout);

 
#endif