io.spine.server.transport

Class ChannelHub<C extends MessageChannel>

java.lang.Object

io.spine.server.transport.ChannelHub<C>

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

PublisherHub, SubscriberHub

@SPI
public abstract class ChannelHub<C extends MessageChannel>
extends java.lang.Object
implements java.lang.AutoCloseable

The hub of channels grouped in some logical way.

Serves for channel creation and storage-per-ID which in a way makes the hub similar to an entity repository.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChannelHub(TransportFactory transportFactory)

Method Summary

Modifier and Type	Method and Description
void	close()
void	closeStaleChannels() Closes the stale channels and removes those from the hub.
C	get(io.spine.server.transport.ChannelId channelId) Obtains a channel from this hub by the given channel ID.
boolean	hasChannel(io.spine.server.transport.ChannelId id) Checks if this channel hub contains a channel with a given ID.
java.util.Set<io.spine.server.transport.ChannelId>	ids()
protected abstract C	newChannel(io.spine.server.transport.ChannelId id) Creates a new channel under the specified ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelHub

protected ChannelHub(TransportFactory transportFactory)

Method Detail

ids

public java.util.Set<io.spine.server.transport.ChannelId> ids()

hasChannel

public boolean hasChannel(io.spine.server.transport.ChannelId id)

Checks if this channel hub contains a channel with a given ID.

Parameters:

id - the ID of the channel

Returns:

true if such a channel is established in this hub, false otherwise

See Also:

ChannelHub.get(ChannelId)

newChannel

protected abstract C newChannel(io.spine.server.transport.ChannelId id)

Creates a new channel under the specified ID.

Parameters:

id - the ID of the channel to create

Returns:

the created channel.

get

public C get(io.spine.server.transport.ChannelId channelId)

Obtains a channel from this hub by the given channel ID.

If there is no channel with this ID in this hub, creates it and adds to the hub prior to returning it as a result of this method call.

Parameters:

channelId - the identifier of the resulting channel

Returns:

a channel with the key

closeStaleChannels

public void closeStaleChannels()

Closes the stale channels and removes those from the hub.

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception