net.openhft.chronicle.network

Interface ConnectionStrategy

All Superinterfaces:

AutoCloseable, Closeable, net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.wire.Marshallable, net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.core.io.Resettable, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.wire.WriteValue

All Known Implementing Classes:

AbstractConnectionStrategy, AlwaysStartOnPrimaryConnectionStrategy, FatalFailureConnectionStrategy

public interface ConnectionStrategy
extends net.openhft.chronicle.wire.Marshallable, Closeable

Field Summary

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

EMPTY

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

DISCARD

Method Summary

Modifier and Type	Method and Description
default ClientConnectionMonitor	clientConnectionMonitor()
default void	close()
ChronicleSocketChannel	connect(@NotNull String name, @NotNull SocketAddressSupplier socketAddressSupplier, boolean didLogIn, @NotNull FatalFailureMonitor fatalFailureMonitor) Connects and returns a new SocketChannel.
default boolean	isClosed()
default @Nullable InetSocketAddress	localSocketBinding() Get the local socket to bind the connection to
default long	maxPauseSec()
default long	minPauseSec()
default ConnectionStrategy	open()
default @Nullable ChronicleSocketChannel	openSocketChannel(@NotNull InetSocketAddress socketAddress, int tcpBufferSize, long timeoutMs)
default @Nullable ChronicleSocketChannel	openSocketChannel(@NotNull InetSocketAddress socketAddress, int tcpBufferSize, long timeoutMs, int socketConnectionTimeoutMs) the reason for this method is that unlike the selector it uses tick time
default void	pauseBeforeReconnect(long startMs)
default long	pauseMillisBeforeReconnect() allows control of a backoff strategy
static @Nullable ChronicleSocketChannel	socketChannel(@NotNull InetSocketAddress socketAddress, int tcpBufferSize, int socketConnectionTimeoutMs) Deprecated. Use ChronicleSocketChannel.builder(InetSocketAddress) instead
default void	throwExceptionIfClosed()

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, readMarshallable, reset, setField, setLongField, streamFromFile, streamFromFile, writeMarshallable

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.CommonMarshallable

usesSelfDescribingMessage

Method Detail

clientConnectionMonitor

default ClientConnectionMonitor clientConnectionMonitor()

socketChannel

@Deprecated
 @Nullable
static @Nullable ChronicleSocketChannel socketChannel(@NotNull
                                                                             @NotNull InetSocketAddress socketAddress,
                                                                             int tcpBufferSize,
                                                                             int socketConnectionTimeoutMs)
                                                                      throws IOException

Deprecated. Use ChronicleSocketChannel.builder(InetSocketAddress) instead

Throws:

IOException

connect

ChronicleSocketChannel connect(@NotNull
                               @NotNull String name,
                               @NotNull
                               @NotNull SocketAddressSupplier socketAddressSupplier,
                               boolean didLogIn,
                               @NotNull
                               @NotNull FatalFailureMonitor fatalFailureMonitor)
                        throws InterruptedException

Connects and returns a new SocketChannel.

Parameters:

name - the name of the connection, only used for logging

socketAddressSupplier - to use for address

didLogIn - was the last attempt successful, was a login established

fatalFailureMonitor - this is invoked on failures

Returns:

the SocketChannel

Throws:

InterruptedException - if the channel is interrupted.

openSocketChannel

@Nullable
default @Nullable ChronicleSocketChannel openSocketChannel(@NotNull
                                                                     @NotNull InetSocketAddress socketAddress,
                                                                     int tcpBufferSize,
                                                                     long timeoutMs)
                                                              throws IOException,
                                                                     InterruptedException

Throws:

IOException

InterruptedException

openSocketChannel

@Nullable
default @Nullable ChronicleSocketChannel openSocketChannel(@NotNull
                                                                     @NotNull InetSocketAddress socketAddress,
                                                                     int tcpBufferSize,
                                                                     long timeoutMs,
                                                                     int socketConnectionTimeoutMs)
                                                              throws IOException,
                                                                     InterruptedException

the reason for this method is that unlike the selector it uses tick time

Throws:

IOException

InterruptedException

pauseBeforeReconnect

default void pauseBeforeReconnect(long startMs)

pauseMillisBeforeReconnect

default long pauseMillisBeforeReconnect()

allows control of a backoff strategy

Returns:

how long in milliseconds to pause before attempting a reconnect

close

default void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isClosed

default boolean isClosed()

open

default ConnectionStrategy open()

throwExceptionIfClosed

default void throwExceptionIfClosed()
                             throws IllegalStateException

Throws:

IllegalStateException

minPauseSec

default long minPauseSec()

maxPauseSec

default long maxPauseSec()

localSocketBinding

@Nullable
default @Nullable InetSocketAddress localSocketBinding()
                                                          throws SocketException,
                                                                 UnknownHostException,
                                                                 IllegalStateException

Get the local socket to bind the connection to

Returns:

the local socket to bind to or null to not bind to any local socket

Throws:

SocketException - If an I/O error occurs

UnknownHostException - If an adddress cannot be resolved

IllegalStateException - If a hostname or interface has no matching addresses