io.spine.server.transport

Interface MessageChannel

All Superinterfaces:

java.lang.AutoCloseable

All Known Subinterfaces:

Publisher

All Known Implementing Classes:

AbstractChannel, InMemoryPublisher, Subscriber

public interface MessageChannel
extends java.lang.AutoCloseable

A channel dedicated to exchanging the messages.

Method Summary

Modifier and Type	Method and Description
static io.spine.server.transport.ChannelId	channelIdFor(io.spine.type.TypeUrl messageType) Converts the given message type into a ChannelId.
io.spine.server.transport.ChannelId	id() Obtains the channel identifier.
boolean	isStale() Allows to understand whether this channel is stale and can be closed.
default io.spine.type.TypeUrl	targetType() Obtains the type of the messages transferred through this channel.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

id

io.spine.server.transport.ChannelId id()

Obtains the channel identifier.

isStale

boolean isStale()

Allows to understand whether this channel is stale and can be closed.

Returns:

true if the channel is stale, false otherwise

targetType

default io.spine.type.TypeUrl targetType()

Obtains the type of the messages transferred through this channel.

channelIdFor

static io.spine.server.transport.ChannelId channelIdFor(io.spine.type.TypeUrl messageType)

Converts the given message type into a ChannelId.

Parameters:

messageType - the type of messages transmitted through the channel

Returns:

channel ID