Files
openflow/include/buffer.h
T
Martin Casado 468e00132f Initial import
2008-03-04 13:12:53 -08:00

64 lines
2.5 KiB
C

/* Copyright (C) 2007 Board of Trustees, Leland Stanford Jr. University.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
#ifndef BUFFER_H
#define BUFFER_H 1
#include <stddef.h>
/* Buffer for holding arbitrary data. A buffer is automatically reallocated as
* necessary if it grows too large for the available memory. */
struct buffer {
void *base; /* First byte of area malloc()'d area. */
size_t allocated; /* Number of bytes allocated. */
void *data; /* First byte actually in use. */
size_t size; /* Number of bytes in use. */
struct buffer *next; /* Next in a list of buffers. */
};
void buffer_use(struct buffer *, void *, size_t);
void buffer_init(struct buffer *, size_t);
void buffer_uninit(struct buffer *);
void buffer_reinit(struct buffer *, size_t);
struct buffer *buffer_new(size_t);
void buffer_delete(struct buffer *);
void *buffer_at(const struct buffer *, size_t offset, size_t size);
void *buffer_at_assert(const struct buffer *, size_t offset, size_t size);
void *buffer_tail(const struct buffer *);
void *buffer_end(const struct buffer *);
void *buffer_put_uninit(struct buffer *, size_t);
void buffer_put(struct buffer *, const void *, size_t);
size_t buffer_headroom(struct buffer *);
size_t buffer_tailroom(struct buffer *);
void buffer_reserve_tailroom(struct buffer *, size_t);
void buffer_clear(struct buffer *);
void buffer_pull(struct buffer *, size_t);
#endif /* buffer.h */