diff options
author | Ben Pfaff <blp@nicira.com> | 2009-10-28 11:06:31 -0700 |
---|---|---|
committer | Ben Pfaff <blp@nicira.com> | 2009-11-04 15:24:40 -0800 |
commit | 1c617a495fdc6bb91e29bf00df4c837f63d63199 (patch) | |
tree | 0702401761b98c270e622645710fed526d38989e /lib/byteq.h | |
parent | c34b65c731a1b6dae014efe8895141e5b2fe758a (diff) | |
download | openvswitch-1c617a495fdc6bb91e29bf00df4c837f63d63199.tar.gz |
byteq: Move from extras/ezio into lib and export some private functions.
The upcoming JSON-RPC library wants to use this library, and it needs some
functions that are currently declared static.
Diffstat (limited to 'lib/byteq.h')
-rw-r--r-- | lib/byteq.h | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/lib/byteq.h b/lib/byteq.h new file mode 100644 index 000000000..84d8696fe --- /dev/null +++ b/lib/byteq.h @@ -0,0 +1,52 @@ +/* Copyright (c) 2008, 2009 Nicira Networks, Inc. + * + * 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 BYTEQ_H +#define BYTEQ_H 1 + +#include <stdbool.h> +#include <stddef.h> +#include <stdint.h> + +/* Maximum number of bytes in a byteq. */ +#define BYTEQ_SIZE 512 + +/* General-purpose circular queue of bytes. */ +struct byteq { + uint8_t buffer[BYTEQ_SIZE]; /* Circular queue. */ + unsigned int head; /* Head of queue. */ + unsigned int tail; /* Chases the head. */ +}; + +void byteq_init(struct byteq *); +int byteq_used(const struct byteq *); +int byteq_avail(const struct byteq *); +bool byteq_is_empty(const struct byteq *); +bool byteq_is_full(const struct byteq *); +void byteq_put(struct byteq *, uint8_t c); +void byteq_putn(struct byteq *, const void *, size_t n); +void byteq_put_string(struct byteq *, const char *); +uint8_t byteq_get(struct byteq *); +int byteq_write(struct byteq *, int fd); +int byteq_read(struct byteq *, int fd); + +uint8_t *byteq_head(struct byteq *); +int byteq_headroom(const struct byteq *); +void byteq_advance_head(struct byteq *, unsigned int n); +int byteq_tailroom(const struct byteq *); +const uint8_t *byteq_tail(const struct byteq *); +void byteq_advance_tail(struct byteq *, unsigned int n); + +#endif /* byteq.h */ |