net.openhft.chronicle.network.cluster

Class ClusterContext<C extends ClusterContext<C,T>,T extends ClusteredNetworkContext<T>>

java.lang.Object

net.openhft.chronicle.wire.AbstractCommonMarshallable

net.openhft.chronicle.wire.SelfDescribingMarshallable

net.openhft.chronicle.network.cluster.ClusterContext<C,T>

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.bytes.BytesMarshallable, net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.bytes.ReadBytesMarshallable, net.openhft.chronicle.bytes.WriteBytesMarshallable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.Resettable, net.openhft.chronicle.wire.Marshallable, net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.wire.WriteValue

public abstract class ClusterContext<C extends ClusterContext<C,T>,T extends ClusteredNetworkContext<T>>
extends net.openhft.chronicle.wire.SelfDescribingMarshallable
implements net.openhft.chronicle.core.io.Closeable, net.openhft.chronicle.core.io.ManagedCloseable

Field Summary

Fields

Modifier and Type	Field and Description
static net.openhft.chronicle.threads.PauserMode	DEFAULT_PAUSER_MODE
protected net.openhft.chronicle.core.threads.EventLoop	eventLoop

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

DISCARD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClusterContext()

Method Summary

Modifier and Type	Method and Description
void	accept(HostDetails hd) Start accepting incoming connections
String	affinityCPU()
C	affinityCPU(String affinityCPU)
void	close() For ClusterContext we add a stage called "STOPPING" in which we close the event loops and wait for them to stop.
Cluster<T,C>	cluster()
void	cluster(Cluster<T,C> cluster)
protected abstract String	clusterNamePrefix()
void	connect(HostDetails hd) Connect to the host specified by the provided HostDetails.
ConnectionManager<T>	connectionManager(int hostId)
protected void	defaults()
@NotNull net.openhft.chronicle.core.threads.EventLoop	eventLoop() Lazily created if not supplier by user
C	eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)
protected List<net.openhft.chronicle.core.threads.EventLoop>	eventLoopsToStop() Subclasses may override to close additional EventLoops when STOPPING
long	heartbeatIntervalMs()
C	heartbeatIntervalMs(long heartbeatIntervalMs)
long	heartbeatTimeoutMs()
C	heartbeatTimeoutMs(long heartbeatTimeoutMs)
boolean	isClosed()
boolean	isClosing()
byte	localIdentifier()
C	localIdentifier(byte localIdentifier)
String	localName()
C	localName(String localName)
Function<C,T>	networkContextFactory()
C	networkContextFactory(Function<C,T> networkContextFactory)
Function<C,NetworkStatsListener<T>>	networkStatsListenerFactory()
C	networkStatsListenerFactory(Function<C,NetworkStatsListener<T>> networkStatsListenerFactory)
Supplier<net.openhft.chronicle.threads.Pauser>	pauserSupplier()
C	pauserSupplier(@NotNull Supplier<net.openhft.chronicle.threads.Pauser> pauserSupplier) Sets the Pauser Supplier to the provided pauserSupplier.
protected void	performClose()
protected void	performStop()
String	procPrefix()
void	procPrefix(String procPrefix)
void	readMarshallable(@NotNull net.openhft.chronicle.wire.WireIn wire)
Supplier<net.openhft.chronicle.threads.Pauser>	replicationPauserSupplier()
C	replicationPauserSupplier(@NotNull Supplier<net.openhft.chronicle.threads.Pauser> replicationPauserSupplier)
long	retryInterval()
C	retryInterval(long retryInterval)
ServerThreadingStrategy	serverThreadingStrategy()
C	serverThreadingStrategy(ServerThreadingStrategy serverThreadingStrategy)
SessionProvider	sessionProvider()
C	sessionProvider(SessionProvider sessionProvider)
protected net.openhft.chronicle.core.threads.EventLoop	synchronizedEventLoop()
abstract @NotNull net.openhft.chronicle.core.util.ThrowingFunction<T,TcpEventHandler<T>,IOException>	tcpEventHandlerFactory()
Function<net.openhft.chronicle.wire.WireType,WireOutPublisher>	wireOutPublisherFactory()
C	wireOutPublisherFactory(Function<net.openhft.chronicle.wire.WireType,WireOutPublisher> wireOutPublisherFactory)
net.openhft.chronicle.wire.WireType	wireType()
C	wireType(net.openhft.chronicle.wire.WireType wireType)
void	writeMarshallable(@NotNull net.openhft.chronicle.wire.WireOut wire)

Methods inherited from class net.openhft.chronicle.wire.SelfDescribingMarshallable

usesSelfDescribingMessage

Methods inherited from class net.openhft.chronicle.wire.AbstractCommonMarshallable

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.core.io.ManagedCloseable

createdHere, throwExceptionIfClosed, warnAndCloseIfNotClosed

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.wire.Marshallable

$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyTo, deepCopy, fromFile, fromFile, fromString, fromString, fromString, getField, getLongField, mergeToMap, reset, setField, setLongField, streamFromFile, streamFromFile

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable

binaryLengthLength, writeValue

Methods inherited from interface net.openhft.chronicle.wire.ReadMarshallable

unexpectedField

Methods inherited from interface net.openhft.chronicle.bytes.BytesMarshallable

$toString, readMarshallable, writeMarshallable

Field Detail

DEFAULT_PAUSER_MODE

public static net.openhft.chronicle.threads.PauserMode DEFAULT_PAUSER_MODE

eventLoop

protected transient net.openhft.chronicle.core.threads.EventLoop eventLoop

Constructor Detail

ClusterContext

protected ClusterContext()

Method Detail

connect

public void connect(HostDetails hd)

Connect to the host specified by the provided HostDetails. Only attempt connection if the remote host has lower host ID than local - this is required to avoid bidirectional connection establishment

Parameters:

hd - remote host details

accept

public void accept(HostDetails hd)

Start accepting incoming connections

Parameters:

hd - local host details to accept on

connectionManager

public ConnectionManager<T> connectionManager(int hostId)

eventLoop

@NotNull
public @NotNull net.openhft.chronicle.core.threads.EventLoop eventLoop()

Lazily created if not supplier by user

Returns:

event loop

synchronizedEventLoop

protected net.openhft.chronicle.core.threads.EventLoop synchronizedEventLoop()

eventLoop

@NotNull
public C eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)

procPrefix

public String procPrefix()

procPrefix

public void procPrefix(String procPrefix)

networkStatsListenerFactory

public Function<C,NetworkStatsListener<T>> networkStatsListenerFactory()

networkStatsListenerFactory

@NotNull
public C networkStatsListenerFactory(Function<C,NetworkStatsListener<T>> networkStatsListenerFactory)

tcpEventHandlerFactory

@NotNull
public abstract @NotNull net.openhft.chronicle.core.util.ThrowingFunction<T,TcpEventHandler<T>,IOException> tcpEventHandlerFactory()

serverThreadingStrategy

public C serverThreadingStrategy(ServerThreadingStrategy serverThreadingStrategy)

serverThreadingStrategy

public ServerThreadingStrategy serverThreadingStrategy()

cluster

public Cluster<T,C> cluster()

cluster

public void cluster(Cluster<T,C> cluster)

defaults

protected void defaults()

localIdentifier

@NotNull
public C localIdentifier(byte localIdentifier)

localIdentifier

public byte localIdentifier()

localName

public C localName(String localName)

localName

public String localName()

wireType

@NotNull
public C wireType(net.openhft.chronicle.wire.WireType wireType)

wireType

public net.openhft.chronicle.wire.WireType wireType()

heartbeatIntervalMs

@NotNull
public C heartbeatIntervalMs(long heartbeatIntervalMs)

heartbeatIntervalMs

public long heartbeatIntervalMs()

heartbeatTimeoutMs

@NotNull
public C heartbeatTimeoutMs(long heartbeatTimeoutMs)

heartbeatTimeoutMs

public long heartbeatTimeoutMs()

pauserSupplier

@NotNull
public C pauserSupplier(@NotNull
                                 @NotNull Supplier<net.openhft.chronicle.threads.Pauser> pauserSupplier)

Sets the Pauser Supplier to the provided pauserSupplier. If the user does not supply an eventLoop() then the pauserSupplier is used when lazily creating the EventGroup.

Parameters:

pauserSupplier - to be used by the event loop

Returns:

this ClusterContext

pauserSupplier

public Supplier<net.openhft.chronicle.threads.Pauser> pauserSupplier()

replicationPauserSupplier

@NotNull
public C replicationPauserSupplier(@NotNull
                                            @NotNull Supplier<net.openhft.chronicle.threads.Pauser> replicationPauserSupplier)

replicationPauserSupplier

public Supplier<net.openhft.chronicle.threads.Pauser> replicationPauserSupplier()

affinityCPU

public String affinityCPU()

affinityCPU

public C affinityCPU(String affinityCPU)

wireOutPublisherFactory

@NotNull
public C wireOutPublisherFactory(Function<net.openhft.chronicle.wire.WireType,WireOutPublisher> wireOutPublisherFactory)

wireOutPublisherFactory

public Function<net.openhft.chronicle.wire.WireType,WireOutPublisher> wireOutPublisherFactory()

networkContextFactory

@NotNull
public C networkContextFactory(Function<C,T> networkContextFactory)

networkContextFactory

public Function<C,T> networkContextFactory()

retryInterval

public C retryInterval(long retryInterval)

retryInterval

public long retryInterval()

sessionProvider

public C sessionProvider(SessionProvider sessionProvider)

sessionProvider

public SessionProvider sessionProvider()

readMarshallable

public void readMarshallable(@NotNull
                             @NotNull net.openhft.chronicle.wire.WireIn wire)
                      throws net.openhft.chronicle.core.io.IORuntimeException

Specified by:

readMarshallable in interface net.openhft.chronicle.wire.Marshallable

Specified by:

readMarshallable in interface net.openhft.chronicle.wire.ReadMarshallable

Throws:

net.openhft.chronicle.core.io.IORuntimeException

writeMarshallable

public void writeMarshallable(@NotNull
                              @NotNull net.openhft.chronicle.wire.WireOut wire)
                       throws net.openhft.chronicle.core.io.InvalidMarshallableException

Specified by:

writeMarshallable in interface net.openhft.chronicle.wire.Marshallable

Specified by:

writeMarshallable in interface net.openhft.chronicle.wire.WriteMarshallable

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

isClosed

public boolean isClosed()

Specified by:

isClosed in interface net.openhft.chronicle.core.io.QueryCloseable

isClosing

public boolean isClosing()

Specified by:

isClosing in interface net.openhft.chronicle.core.io.QueryCloseable

close

public void close()

For ClusterContext we add a stage called "STOPPING" in which we close the event loops and wait for them to stop. In "STOPPING" phase, ManagedCloseable.throwExceptionIfClosed() does not throw. This allows the handlers to finish their last iteration without producing a lot of log noise because the context is closed.

This close() method will block until the event loops are finished and everything is closed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

performStop

protected void performStop()

eventLoopsToStop

protected List<net.openhft.chronicle.core.threads.EventLoop> eventLoopsToStop()

Subclasses may override to close additional EventLoops when STOPPING

Returns:

The list of event loops to stop before entering CLOSING phase

performClose

protected void performClose()

clusterNamePrefix

protected abstract String clusterNamePrefix()