Package dev.objz.commandbridge.api.channel

Interface MessageChannel<P extends ChannelPayload>

Type Parameters:

P - the type of payload handled by this channel; must extend ChannelPayload

public interface MessageChannel<P extends ChannelPayload>

A typed communication pipe for sending and receiving messages across the CommandBridge network.

A MessageChannel is bound to a specific payload type P, providing type-safe message routing. Target one or more servers with to(java.util.Collection), broadcast to all connected servers with toAll(), or subscribe to incoming messages with listen(dev.objz.commandbridge.api.message.MessageListener).

All send operations return CompletableFuture and are non-blocking.

To send a payload to a specific server:

 channel.to(List.of(Platform.backend("survival-1")))
         .send(payload);
 

To broadcast to every connected server:

 channel.toAll().send(payload);
 

To subscribe to incoming messages and cancel the listener later:

 Subscription sub = channel.listen((ctx, payload) ->
         System.out.println("From " + ctx.from().id()));
 sub.cancel();
 

See Also:

• CommandBridgeAPI.channel(Class)
• MessageChannel.Sender
• MessageListener

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MessageChannel.Sender<P extends ChannelPayload>	A target-bound sender created by to(java.util.Collection) or toAll(), used to dispatch payloads to the targeted servers.

Method Summary

Modifier and Type	Method	Description
Subscription	listen(MessageListener<P> listener)	Subscribes to messages received on this channel.
MessageChannel.Sender<P>	to(Collection<Platform.ServerTarget> targets)	Returns a MessageChannel.Sender targeting the specified servers.
MessageChannel.Sender<P>	toAll()	Returns a MessageChannel.Sender that broadcasts to all servers currently connected to the bridge network.

Method Details

to

MessageChannel.Sender<P> to(Collection<Platform.ServerTarget> targets)

Returns a MessageChannel.Sender targeting the specified servers.

Parameters:

targets - the destination servers; must not be null or empty. The collection is captured at call time.

Returns:

a Sender scoped to the given targets

See Also:

• toAll()

toAll

MessageChannel.Sender<P> toAll()

Returns a MessageChannel.Sender that broadcasts to all servers currently connected to the bridge network.

Returns:

a Sender targeting every currently connected server. The set of servers is determined at send time, not at the time this method is called.

See Also:

• to(java.util.Collection)

listen

Subscription listen(MessageListener<P> listener)

Subscribes to messages received on this channel.

Parameters:

listener - the callback to invoke for each incoming message; must not be null

Returns:

a Subscription that can be cancelled via Subscription.cancel() to stop receiving messages. The listener remains active until cancelled.

See Also:

• Subscription.cancel()