Package dev.cachly

Class PubSubClient

java.lang.Object

dev.cachly.PubSubClient

public class PubSubClient
extends Object

Pub/Sub client for real-time messaging via the cachly API. Obtain via CachlyClient.pubsub().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PubSubClient.ChannelInfo	Information about a single active channel.
static final class	PubSubClient.Message	A single message received via SSE subscription.
static final class	PubSubClient.PublishResult	Result of a publish operation.
static final class	PubSubClient.StatsResult	Aggregate pub/sub statistics.

Method Summary

Modifier and Type	Method	Description
List<PubSubClient.ChannelInfo>	channels()	List active channels.
PubSubClient.PublishResult	publish(String channel, String message)	Publish a message to a channel.
PubSubClient.StatsResult	stats()	Pub/Sub aggregate statistics.
void	subscribe(List<String> channels, Consumer<PubSubClient.Message> consumer)	Subscribe to one or more channels via SSE (blocking, calls consumer for each message).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

publish

public PubSubClient.PublishResult publish(String channel,
 String message)
                                   throws CachlyException

Publish a message to a channel. POST {pubsubUrl}/publish

Throws:

CachlyException

subscribe

public void subscribe(List<String> channels,
 Consumer<PubSubClient.Message> consumer)
               throws CachlyException

Subscribe to one or more channels via SSE (blocking, calls consumer for each message). Returns when the stream closes or an error occurs. POST {pubsubUrl}/subscribe

Throws:

CachlyException

channels

public List<PubSubClient.ChannelInfo> channels()
                                        throws CachlyException

List active channels. GET {pubsubUrl}/channels

Throws:

CachlyException

stats

public PubSubClient.StatsResult stats()
                               throws CachlyException

Pub/Sub aggregate statistics. GET {pubsubUrl}/stats

Throws:

CachlyException