bufring.h

Go to the documentation of this file.

#pragma once
 
#include <cx/cx.h>
#include "cx/buffer/buffer.h"
#include "cx/utils/compare.h"
 
CX_C_BEGIN
 
 
 
typedef struct BufRingNode BufRingNode;
typedef struct BufRingNode {
    BufRingNode* next;   
    Buffer buf;          
    size_t head;         
    size_t tail;         
    bool full;           
} BufRingNode;
 
typedef struct BufRing {
    BufRingNode* head;   
    BufRingNode* tail;   
    size_t total;        
    size_t segsz;        
    size_t reserved;     
} BufRing;
 
typedef bool (*bufringZCCB)(_In_reads_bytes_(bytes) const uint8* buf, size_t bytes,
                            _Pre_opt_valid_ void* ctx);
 
typedef size_t (*bufringFeedCB)(_Out_writes_bytes_(maxbytes) uint8* buf, size_t maxbytes,
                                _Pre_opt_valid_ void* ctx);
 
void bufringInit(_Out_ BufRing* ring, size_t segsz);
 
size_t bufringRead(_Inout_ BufRing* ring, _Out_writes_bytes_(bytes) uint8* buf, size_t bytes);
 
_meta_inline size_t bufringReadBuf(_Inout_ BufRing* ring, _Inout_ Buffer buf, size_t maxbytes)
{
    buf->len = bufringRead(ring, buf->data, min(buf->sz, maxbytes));
    return buf->len;
}
 
size_t bufringPeek(_Inout_ BufRing* ring, _Out_writes_bytes_(bytes) uint8* buf, size_t off,
                   size_t bytes);
 
_meta_inline size_t bufringPeekBuf(_Inout_ BufRing* ring, _Inout_ Buffer buf, size_t off,
                                   size_t maxbytes)
{
    buf->len = bufringPeek(ring, buf->data, off, min(buf->sz, maxbytes));
    return buf->len;
}
 
size_t bufringSkip(_Inout_ BufRing* ring, size_t bytes);
 
size_t bufringReadZC(_Inout_ BufRing* ring, size_t bytes, bufringZCCB cb, _Inout_opt_ void* ctx);
 
void bufringWrite(_Inout_ BufRing* ring, _In_reads_bytes_(bytes) const uint8* buf, size_t bytes);
 
_meta_inline void bufringWriteBuf(_Inout_ BufRing* ring, _In_ Buffer buf)
{
    bufringWrite(ring, buf->data, buf->len);
}
 
_At_(*buf, _Pre_notnull_ _Post_null_) void bufringWriteZC(_Inout_ BufRing* ring, _Inout_ Buffer* buf);
 
size_t bufringWriteSpace(_In_ BufRing* ring);
 
size_t bufringFeed(_Inout_ BufRing* ring, bufringFeedCB feed, size_t bytes, _Inout_opt_ void* ctx);
 
size_t bufringWriteSpace(_In_ BufRing* ring);
 
size_t bufringFeed(_Inout_ BufRing* ring, bufringFeedCB feed, size_t bytes, _Inout_opt_ void* ctx);
 
void bufringReserve(_Inout_ BufRing* ring, size_t minbytes,
                    _Outptr_result_buffer_(*len) uint8** ptr, _Out_ size_t* len);
 
void bufringCommit(_Inout_ BufRing* ring, size_t bytes);
 
void bufringDestroy(_Pre_notnull_ _Post_invalid_ BufRing* ring);
 
 
CX_C_END