Sturk 1.1.0
Publish-subscribe C implementation.
Loading...
Searching...
No Matches
broker.h
Go to the documentation of this file.
1/*
2BSD 3-Clause License
3
4Copyright (c) 2025, Szymon Turno
5
6Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are met:
8
91. Redistributions of source code must retain the above copyright notice, this
10 list of conditions and the following disclaimer.
11
122. Redistributions in binary form must reproduce the above copyright notice,
13 this list of conditions and the following disclaimer in the documentation
14 and/or other materials provided with the distribution.
15
163. Neither the name of the copyright holder nor the names of its
17 contributors may be used to endorse or promote products derived from
18 this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30*/
31
41#ifndef ST_BROKER_H
42#define ST_BROKER_H
43
44#include <stdarg.h>
45#include <stddef.h>
46
60 size_t (*size_cb)(void);
61
75 void (*ctor)(void*, va_list);
76
84 void (*dtor)(void*);
85};
86
97typedef struct StBroker StBroker;
98
105
115typedef struct StChannel StChannel;
116
129void st_publish(StChannel* ch, ...);
130
139void st_subscribe(StSubscriber* sber, const char* topic);
140
157
166
179StChannel* st_broker_search(StBroker* broker, const char* topic);
180
190const char* st_channel_gettopic(const StChannel* ch);
191
202
211
229
243
260
261#endif /* ST_BROKER_H */
StSubscriber * st_subscriber_create(StBroker *broker)
Create the subscriber.
struct StSubscriber StSubscriber
The subscriber.
Definition broker.h:104
void st_subscribe(StSubscriber *sber, const char *topic)
Subscribe to a topic.
void st_subscriber_destroy(StSubscriber *sber)
Destroy the subscriber.
void * st_subscriber_await(StSubscriber *sber)
Wait for the messages that are wanted by the subscriber.
void st_subscriber_unload(StSubscriber *sber)
Inform the broker that the message can be released for the given subscriber.
struct StBroker StBroker
The message broker.
Definition broker.h:97
const char * st_channel_gettopic(const StChannel *ch)
Get the topic for the given channel.
void st_broker_destroy(StBroker *broker)
Destroy the message broker.
StBroker * st_broker_create(const struct StMessageVt *vp)
Create the message broker.
void * st_subscriber_poll(StSubscriber *sber)
Poll for the messages that are wanted by the subscriber.
void st_publish(StChannel *ch,...)
Broadcast the message.
struct StChannel StChannel
The channel for messages.
Definition broker.h:115
StChannel * st_broker_search(StBroker *broker, const char *topic)
Find the channel that is assigned to the given topic.
Vtable for message construction.
Definition broker.h:52
void(* dtor)(void *)
Destructor callback for the message.
Definition broker.h:84
size_t(* size_cb)(void)
Callback for obtaining the size of the message.
Definition broker.h:60
void(* ctor)(void *, va_list)
Constructor callback for the message.
Definition broker.h:75