chic/spsc_8h_source.html

// This Source Code Form is subject to the terms of the Mozilla Public

// License, v. 2.0. If a copy of the MPL was not distributed with this

// file, You can obtain one at https://mozilla.org/MPL/2.0/.


#pragma once

#include "claim.h"

#include "err.h"


#ifdef __cplusplus

    #if defined(__clang__) || defined(__GNUG__) || defined(_MSC_VER)

        #define restrict __restrict

    #else

        #define restrict

    #endif

    extern "C" {

#endif


struct spsc;


#define make_spsc(N, T) spsc_alloc((N), sizeof(T))


#define sizeof_spsc(N, T) spsc_open(NULL, (N), sizeof(T))


#define spsc_send1(C, SRC) spsc_send((C), 1, (SRC))


#define spsc_nbsend1(C, SRC) spsc_nbsend((C), 1, (SRC))


#define spsc_recv1(C, DST) spsc_recv((C), 1, (DST))


#define spsc_nbrecv1(C, DST) spsc_nbrecv((C), 1, (DST))


size_t spsc_open(void *c, size_t nel, size_t elsize);


struct spsc *spsc_alloc(size_t nel, size_t elsize);


enum chic_err spsc_close(struct spsc *c);


size_t spsc_nel(struct spsc *c);


enum chic_err spsc_send_init(struct spsc *c, size_t n, struct claim *s);


enum chic_err spsc_send_nbinit(struct spsc *c, size_t n, struct claim *s);


void spsc_send_fini(struct spsc *c, struct claim *s);


enum chic_err spsc_send(struct spsc *restrict c, size_t n, void *restrict src);


enum chic_err spsc_nbsend(struct spsc *restrict c, size_t n, size_t *restrict n2, void *restrict src);


enum chic_err spsc_sendv(struct spsc *restrict c, size_t n, ...);


enum chic_err spsc_nbsendv(struct spsc *restrict c, size_t n, size_t *restrict n2, ...);


enum chic_err spsc_recv_init(struct spsc *c, size_t n, struct claim *r);


enum chic_err spsc_recv_nbinit(struct spsc *c, size_t n, struct claim *r);


void spsc_recv_fini(struct spsc *c, struct claim *r);


enum chic_err spsc_recv(struct spsc *restrict c, size_t n, void *restrict dst);


enum chic_err spsc_nbrecv(struct spsc *restrict c, size_t n, size_t *restrict n2, void *restrict dst);


enum chic_err spsc_recvv(struct spsc *restrict c, size_t n, ...);


enum chic_err spsc_nbrecvv(struct spsc *restrict c, size_t n, size_t *restrict n2, ...);


#ifdef __cplusplus

    }

    #undef restrict

#endif

claim.h
Exclusive claims for directly reading/writing into channels.

err.h
Error enumeration definition.

chic_err
chic_err
Identifiers for channel states and errors.
Definition err.h:14

spsc_recv_nbinit
enum chic_err spsc_recv_nbinit(struct spsc *c, size_t n, struct claim *r)
Claims up to an amount of space in the channel to be manually read from.

spsc_recv_init
enum chic_err spsc_recv_init(struct spsc *c, size_t n, struct claim *r)
Claims space in the channel to be manually read from.

spsc_send_init
enum chic_err spsc_send_init(struct spsc *c, size_t n, struct claim *s)
Claims space in the channel to be manually written into.

spsc_send_nbinit
enum chic_err spsc_send_nbinit(struct spsc *c, size_t n, struct claim *s)
Claims up to an amount of space in the channel to be manually written into.

spsc_recv_fini
void spsc_recv_fini(struct spsc *c, struct claim *r)
Commits a claim, indicating the item slots within have been read from and are safe to be overwritten.

spsc_send_fini
void spsc_send_fini(struct spsc *c, struct claim *s)
Commits a claim, indicating the item slots within have been written to and are ready to be received.

spsc_send
enum chic_err spsc_send(struct spsc *restrict c, size_t n, void *restrict src)
Sends items to a channel.

spsc_recvv
enum chic_err spsc_recvv(struct spsc *restrict c, size_t n,...)
Receives items from a channel.

spsc_nbrecv
enum chic_err spsc_nbrecv(struct spsc *restrict c, size_t n, size_t *restrict n2, void *restrict dst)
Receives whatever items are available from a channel.

spsc_nel
size_t spsc_nel(struct spsc *c)
Gets the maximim number of elements a channel is capable of holding at once.

spsc_alloc
struct spsc * spsc_alloc(size_t nel, size_t elsize)
Allocates a new spsc using malloc() and opens it.

spsc_sendv
enum chic_err spsc_sendv(struct spsc *restrict c, size_t n,...)
Sends items to a channel.

spsc_close
enum chic_err spsc_close(struct spsc *c)
Closes a channel, forbidding any future send operations on it.

spsc_nbsendv
enum chic_err spsc_nbsendv(struct spsc *restrict c, size_t n, size_t *restrict n2,...)
Sends whatever items will fit to a channel.

spsc_recv
enum chic_err spsc_recv(struct spsc *restrict c, size_t n, void *restrict dst)
Receives items from a channel.

spsc_nbsend
enum chic_err spsc_nbsend(struct spsc *restrict c, size_t n, size_t *restrict n2, void *restrict src)
Sends whatever items will fit to a channel.

spsc_nbrecvv
enum chic_err spsc_nbrecvv(struct spsc *restrict c, size_t n, size_t *restrict n2,...)
Receives whatever items are available from a channel.

spsc_open
size_t spsc_open(void *c, size_t nel, size_t elsize)
Constructs a spsc in-place, or calculates the needed allocation size for one.

claim
Claimed space for reading or writing directly into the internal ringbuffer of a channel.
Definition claim.h:66

spsc
Single-producer, single-consumer channel.