mirror of
https://github.com/moparisthebest/spdylay
synced 2024-12-22 23:58:53 -05:00
164 lines
5.4 KiB
C
164 lines
5.4 KiB
C
/*
|
|
* Spdylay - SPDY Library
|
|
*
|
|
* Copyright (c) 2012 Tatsuhiro Tsujikawa
|
|
*
|
|
* 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 SPDYLAY_BUFFER_H
|
|
#define SPDYLAY_BUFFER_H
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
# include <config.h>
|
|
#endif /* HAVE_CONFIG_H */
|
|
|
|
#include <spdylay/spdylay.h>
|
|
|
|
typedef struct spdylay_buffer_chunk {
|
|
uint8_t *data;
|
|
struct spdylay_buffer_chunk *next;
|
|
} spdylay_buffer_chunk;
|
|
|
|
/*
|
|
* List of fixed sized chunks
|
|
*/
|
|
typedef struct {
|
|
/* Capacity of each chunk buffer */
|
|
size_t capacity;
|
|
/* Root of list of chunk buffers. The root is dummy and its data
|
|
member is always NULL. */
|
|
spdylay_buffer_chunk root;
|
|
/* Points to the current chunk to write */
|
|
spdylay_buffer_chunk *current;
|
|
/* Total length of this buffer */
|
|
size_t len;
|
|
/* Offset of last chunk buffer */
|
|
size_t last_offset;
|
|
} spdylay_buffer;
|
|
|
|
/*
|
|
* Initializes buffer with fixed chunk size chunk_capacity.
|
|
*/
|
|
void spdylay_buffer_init(spdylay_buffer *buffer, size_t chunk_capacity);
|
|
/* Releases allocated memory for buffer */
|
|
void spdylay_buffer_free(spdylay_buffer *buffer);
|
|
/* Returns buffer pointer */
|
|
uint8_t* spdylay_buffer_get(spdylay_buffer *buffer);
|
|
/* Returns available buffer length */
|
|
size_t spdylay_buffer_avail(spdylay_buffer *buffer);
|
|
/* Advances buffer pointer by amount. This reduces available buffer
|
|
length. */
|
|
void spdylay_buffer_advance(spdylay_buffer *buffer, size_t amount);
|
|
|
|
/*
|
|
* Writes the |data| with the |len| bytes starting at the current
|
|
* position of the |buffer|. The new chunk buffer will be allocated on
|
|
* the course of the write and the current position is updated. If
|
|
* this function succeeds, the total length of the |buffer| will be
|
|
* increased by |len|.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative error codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_buffer_write(spdylay_buffer *buffer, const uint8_t *data,
|
|
size_t len);
|
|
|
|
/*
|
|
* Allocate new chunk buffer. This will increase total length of
|
|
* buffer (returned by spdylay_buffer_length) by capacity-last_offset.
|
|
* It means untouched buffer is assumued to be written.
|
|
*
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
* negative eror codes:
|
|
*
|
|
* SPDYLAY_ERR_NOMEM
|
|
* Out of memory.
|
|
*/
|
|
int spdylay_buffer_alloc(spdylay_buffer *buffer);
|
|
|
|
/* Returns total length of buffer */
|
|
size_t spdylay_buffer_length(spdylay_buffer *buffer);
|
|
|
|
/* Returns capacity of each fixed chunk buffer */
|
|
size_t spdylay_buffer_capacity(spdylay_buffer *buffer);
|
|
|
|
/* Stores the contents of buffer into |buf|. |buf| must be at least
|
|
spdylay_buffer_length(buffer) bytes long. */
|
|
void spdylay_buffer_serialize(spdylay_buffer *buffer, uint8_t *buf);
|
|
|
|
/* Reset |buffer| for reuse. Set the total length of buffer to 0.
|
|
Next spdylay_buffer_avail() returns 0. This function does not free
|
|
allocated memory space; they are reused. */
|
|
void spdylay_buffer_reset(spdylay_buffer *buffer);
|
|
|
|
/*
|
|
* Reader interface to read data from spdylay_buffer sequentially.
|
|
*/
|
|
typedef struct {
|
|
/* The buffer to read */
|
|
spdylay_buffer *buffer;
|
|
/* Pointer to the current chunk to read. */
|
|
spdylay_buffer_chunk *current;
|
|
/* Offset to the current chunk data to read. */
|
|
size_t offset;
|
|
} spdylay_buffer_reader;
|
|
|
|
/*
|
|
* Initializes the |reader| with the |buffer|.
|
|
*/
|
|
void spdylay_buffer_reader_init(spdylay_buffer_reader *reader,
|
|
spdylay_buffer *buffer);
|
|
|
|
/*
|
|
* Reads 1 byte and return it. This function will advance the current
|
|
* position by 1.
|
|
*/
|
|
uint8_t spdylay_buffer_reader_uint8(spdylay_buffer_reader *reader);
|
|
|
|
/*
|
|
* Reads 2 bytes integer in network byte order and returns it in host
|
|
* byte order. This function will advance the current position by 2.
|
|
*/
|
|
uint16_t spdylay_buffer_reader_uint16(spdylay_buffer_reader *reader);
|
|
|
|
/*
|
|
* Reads 4 bytes integer in network byte order and returns it in host
|
|
* byte order. This function will advance the current position by 4.
|
|
*/
|
|
uint32_t spdylay_buffer_reader_uint32(spdylay_buffer_reader *reader);
|
|
|
|
/*
|
|
* Reads |len| bytes and store them in the |out|. This function will
|
|
* advance the current position by |len|.
|
|
*/
|
|
void spdylay_buffer_reader_data(spdylay_buffer_reader *reader,
|
|
uint8_t *out, size_t len);
|
|
|
|
/*
|
|
* Advances the current position by |amount|.
|
|
*/
|
|
void spdylay_buffer_reader_advance(spdylay_buffer_reader *reader,
|
|
size_t amount);
|
|
|
|
#endif /* SPDYLAY_BUFFER_H */
|