mpsc.h

Go to the documentation of this file.

/*
    Copyright (c) 2024 BB-301 <fw3dg3@gmail.com>
    [Official repository](https://github.com/BB-301/c-mpsc)
 
    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 _MPSC_H_
#define _MPSC_H_
 
#include <stdbool.h>
#include <stddef.h>
 
typedef enum
{
    MPSC_REGISTER_PRODUCER_ERROR_NONE = 0,
    MPSC_REGISTER_PRODUCER_ERROR_CLOSED = 1,
    MPSC_REGISTER_PRODUCER_ERROR_N_MAX_PRODUCERS_REACHED = 2,
    MPSC_REGISTER_PRODUCER_ERROR_EAGAIN = 3
} mpsc_register_producer_error_t;
 
typedef struct mpsc_s mpsc_t;
 
typedef struct mpsc_consumer_s mpsc_consumer_t;
 
typedef struct mpsc_producer_s mpsc_producer_t;
 
typedef void(mpsc_producer_thread_callback_t)(mpsc_producer_t *producer);
 
typedef void(mpsc_consumer_callback_t)(mpsc_consumer_t *consumer, void *data, size_t n, bool closed);
 
typedef void(mpsc_consumer_error_callback_t)(mpsc_consumer_t *consumer);
 
typedef struct
{
    size_t buffer_size;
    size_t n_max_producers;
    mpsc_consumer_callback_t *consumer_callback;
    mpsc_consumer_error_callback_t *consumer_error_callback;
    bool error_handling_enabled;
    bool create_and_join_thread_safety_disabled;
} mpsc_create_params_t;
 
mpsc_t *mpsc_create(mpsc_create_params_t params);
 
void mpsc_join(mpsc_t *self);
 
mpsc_register_producer_error_t mpsc_register_producer(mpsc_t *self, mpsc_producer_thread_callback_t callback, void *context);
 
mpsc_register_producer_error_t mpsc_consumer_register_producer(mpsc_consumer_t *self, mpsc_producer_thread_callback_t callback, void *context);
 
void mpsc_consumer_close(mpsc_consumer_t *self);
 
bool mpsc_producer_ping(mpsc_producer_t *self);
 
bool mpsc_producer_send(mpsc_producer_t *self, void *data, size_t n);
 
bool mpsc_producer_send_empty(mpsc_producer_t *self);
 
void *mpsc_producer_context(mpsc_producer_t *self);
 
mpsc_register_producer_error_t mpsc_producer_register_producer(mpsc_producer_t *self, mpsc_producer_thread_callback_t callback, void *context);
 
#endif