/usr/include/globus/globus_fifo.h is in libglobus-common-dev 16.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | /*
* Copyright 1999-2006 University of Chicago
*
* Licensed 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 GLOBUS_FIFO_H
#define GLOBUS_FIFO_H
/**
* @file globus_fifo.h
* @brief Globus FIFO
*
* This file defines the globus_fifo_t type
* useful for queuing arbitrary data (via void-pointer)
*/
/**
* @defgroup globus_fifo FIFO Queue
* @ingroup globus_common
* @brief FIFO Queue Implementation
*/
#include "globus_list.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @ingroup globus_fifo
* Opaque structure used to implement the Globus FIFO
*/
struct globus_fifo_s;
/**
* @ingroup globus_fifo
* Data type used in all function calls to manipulate a Globus FIFO
*/
typedef struct globus_fifo_s * globus_fifo_t;
/**
* @ingroup globus_fifo
* @brief Initialize the fifo structure.
*
* This function initializes the fifo data structure. The structure
* must be initalized before it can be used with any other function.
*/
extern int
globus_fifo_init(
globus_fifo_t * fifo);
/**
* @ingroup globus_fifo
* Destroy the fifo data structure.
*
* This function destroys the memory associate with the fifo data structure.
* For every call to globus_fifo_init() there must be a corresponding call to
* globus_fifo_destroy()
*/
extern void
globus_fifo_destroy(
globus_fifo_t * fifo);
/**
* @ingroup globus_fifo
* Destroy the fifo data structure.
*
* This function destroys the memory associate with the fifo data structure.
* It calls datum_free() on behalf of all remaining nodes in the queue.
* For every call to globus_fifo_init() there must be a corresponding call to
* globus_fifo_destroy()
*/
void
globus_fifo_destroy_all(
globus_fifo_t * fifo,
void (*datum_free)(void *));
/**
* @ingroup globus_fifo
* This function returns a boolean indicating whether or not the
* fifo is empty.
*/
extern int
globus_fifo_empty(
const globus_fifo_t * fifo);
/**
* @ingroup globus_fifo
* This function returns a interger representing the number
* of elements in the queue.
*/
extern int
globus_fifo_size(
const globus_fifo_t * fifo);
/**
* @ingroup globus_fifo
* Add data to the back of the queue.
*/
extern int
globus_fifo_enqueue(
globus_fifo_t * fifo,
void * datum);
/**
* @ingroup globus_fifo
* Make a copy of the fifo. globus_fifo_destroy() must be called
* the returned pointer to free memory associated with it.
*/
extern globus_fifo_t *
globus_fifo_copy(
const globus_fifo_t * fifo);
/**
* @ingroup globus_fifo
* get a pointer to the element at the front of the queue.
*/
extern void *
globus_fifo_peek(
globus_fifo_t * fifo);
/**
* @ingroup globus_fifo
* Get a pointer to the element at the back of the queue.
*/
extern void *
globus_fifo_tail_peek(
globus_fifo_t * fifo);
/**
* @ingroup globus_fifo
* remove datum from anywhere in the queue.
*/
extern void *
globus_fifo_remove(
globus_fifo_t * headp,
void * datum);
/**
* @ingroup globus_fifo
* dequeue the element at the front of the queue.
*/
extern void *
globus_fifo_dequeue(
globus_fifo_t * fifo);
/**
* @ingroup globus_fifo
* Move the queue from fifo_src pointer to fifo_dest pointer.
*/
extern int
globus_fifo_move(
globus_fifo_t * fifo_dest,
globus_fifo_t * fifo_src);
/**
* @ingroup globus_fifo
* Convert the fifo into a list.
*/
extern globus_list_t *
globus_fifo_convert_to_list(
globus_fifo_t * fifo );
#ifdef __cplusplus
}
#endif
#endif /* GLOBUS_FIFO_H */
|