io.spine.server.transport.memory

Class InMemoryTransportFactory

java.lang.Object

io.spine.server.transport.memory.InMemoryTransportFactory

All Implemented Interfaces:

Closeable, TransportFactory, java.lang.AutoCloseable

Direct Known Subclasses:

SingleThreadInMemTransportFactory

public class InMemoryTransportFactory
extends java.lang.Object
implements TransportFactory

In-memory implementation of the TransportFactory.

Publishers and subscribers must be in the same JVM. Therefore this factory usage should be limited to tests.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InMemoryTransportFactory() Prevent direct instantiation from outside of the inheritance tree.

Method Summary

Modifier and Type	Method and Description
void	close()
Publisher	createPublisher(io.spine.server.transport.ChannelId id) Creates a Publisher channel with the given ID.
Subscriber	createSubscriber(io.spine.server.transport.ChannelId id) Creates a Subscriber channel with the given ID.
boolean	isOpen() Tells if the object is still open.
static InMemoryTransportFactory	newInstance() Creates a new instance of InMemoryTransportFactory.
protected Subscriber	newSubscriber(io.spine.server.transport.ChannelId id) Creates a new instance of subscriber.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spine.server.Closeable

checkOpen

Constructor Detail

InMemoryTransportFactory

protected InMemoryTransportFactory()

Prevent direct instantiation from outside of the inheritance tree.

Method Detail

newInstance

public static InMemoryTransportFactory newInstance()

Creates a new instance of InMemoryTransportFactory.

Returns:

a new instance of this factory

createPublisher

public final Publisher createPublisher(io.spine.server.transport.ChannelId id)

Description copied from interface: TransportFactory

Creates a Publisher channel with the given ID.

Specified by:

createPublisher in interface TransportFactory

Parameters:

id - the identifier of the resulting channel

Returns:

a new Publisher instance

createSubscriber

public final Subscriber createSubscriber(io.spine.server.transport.ChannelId id)

Description copied from interface: TransportFactory

Creates a Subscriber channel with the given ID.

Specified by:

createSubscriber in interface TransportFactory

Parameters:

id - the identifier of the resulting channel

Returns:

a new Subscriber instance

newSubscriber

protected Subscriber newSubscriber(io.spine.server.transport.ChannelId id)

Creates a new instance of subscriber.

The descendants may override this method to customize the implementation of subscribers to use within this TransportFactory instance.

Parameters:

id - the identifier of the resulting subscriber

Returns:

an instance of subscribe

isOpen

public boolean isOpen()

Description copied from interface: Closeable

Tells if the object is still open.

Implementations must return false after AutoCloseable.close() is invoked.

Specified by:

isOpen in interface Closeable

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable