net.openhft.chronicle.network.connection

Class TcpChannelHub

java.lang.Object

net.openhft.chronicle.network.connection.TcpChannelHub

All Implemented Interfaces:

Closeable, AutoCloseable

public class TcpChannelHub
extends Object
implements net.openhft.chronicle.core.io.Closeable

Created by Rob Austin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TcpChannelHub.Task

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEATBEAT_PING_PERIOD
static int	HEATBEAT_TIMEOUT_PERIOD
protected String	name
static int	SIZE_OF_SIZE
protected int	tcpBufferSize
long	timeoutMs

Constructor Summary

Constructors

Constructor and Description
TcpChannelHub(SessionProvider sessionProvider, net.openhft.chronicle.threads.api.EventLoop eventLoop, java.util.function.Function<net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.wire.Wire> wire, String name, SocketAddressSupplier socketAddressSupplier)

Method Summary

Modifier and Type	Method and Description
void	checkConnection() blocks until there is a connection
void	close() called when we are completed finished with using the TcpChannelHub
protected void	closeSocket() closes the existing connections
boolean	isOpen()
boolean	lock(TcpChannelHub.Task r)
boolean	lock(TcpChannelHub.Task r, boolean tryLock)
long	nextUniqueTransaction(long timeMs) the transaction id are generated as unique timestamps
ReentrantLock	outBytesLock()
net.openhft.chronicle.wire.Wire	outWire()
void	preventSubscribeUponReconnect(long tid) prevents subscriptions upon reconnect for the following tid its useful to call this method when an unsubscribe has been sent to the server, but before the server has acknoleged the unsubscribe, hence, perverting a resubscribe uppon reconnection.
net.openhft.chronicle.wire.Wire	proxyReply(long timeoutTime, long tid)
void	subscribe(AsyncSubscription asyncSubscription) sets up subscriptions with the server, even if the socket connection is down, the subscriptions will be re-establish with the server automatically once it comes back up.
void	subscribe(AsyncSubscription asyncSubscription, boolean tryLock)
String	toString()
void	unsubscribe(long tid) closes a subscription established by net.openhft.chronicle.network.connection.TcpChannelHub# subscribe(net.openhft.chronicle.network.connection.AsyncSubscription)
void	writeAsyncHeader(net.openhft.chronicle.wire.Wire wire, String csp, long cid) The writes the meta data to wire - the async version does not contain the tid
void	writeMetaDataForKnownTID(long tid, net.openhft.chronicle.wire.Wire wire, String csp, long cid)
long	writeMetaDataStartTime(long startTime, net.openhft.chronicle.wire.Wire wire, String csp, long cid)
void	writeSocket(net.openhft.chronicle.wire.WireOut wire) sends data to the server via TCP/IP

Methods inherited from class java.lang.Object

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

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

closeQuietly

Field Detail

HEATBEAT_PING_PERIOD

public static final int HEATBEAT_PING_PERIOD

HEATBEAT_TIMEOUT_PERIOD

public static final int HEATBEAT_TIMEOUT_PERIOD

SIZE_OF_SIZE

public static final int SIZE_OF_SIZE

See Also:

Constant Field Values

timeoutMs

public final long timeoutMs

name

@NotNull
protected final String name

tcpBufferSize

protected final int tcpBufferSize

Constructor Detail

TcpChannelHub

public TcpChannelHub(@NotNull
                     SessionProvider sessionProvider,
                     @NotNull
                     net.openhft.chronicle.threads.api.EventLoop eventLoop,
                     @NotNull
                     java.util.function.Function<net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.wire.Wire> wire,
                     @NotNull
                     String name,
                     @NotNull
                     SocketAddressSupplier socketAddressSupplier)

Method Detail

preventSubscribeUponReconnect

public void preventSubscribeUponReconnect(long tid)

prevents subscriptions upon reconnect for the following tid its useful to call this method when an unsubscribe has been sent to the server, but before the server has acknoleged the unsubscribe, hence, perverting a resubscribe uppon reconnection.

Parameters:

tid - unique transcation id

toString

@NotNull
public String toString()

Overrides:

toString in class Object

subscribe

public void subscribe(@NotNull
                      AsyncSubscription asyncSubscription)

sets up subscriptions with the server, even if the socket connection is down, the subscriptions will be re-establish with the server automatically once it comes back up. To end the subscription with the server call net.openhft.chronicle.network.connection.TcpChannelHub#unsubscribe(long)

Parameters:

asyncSubscription - detail of the subscription that you wish to hold with the server

subscribe

public void subscribe(@NotNull
                      AsyncSubscription asyncSubscription,
                      boolean tryLock)

unsubscribe

public void unsubscribe(long tid)

closes a subscription established by net.openhft.chronicle.network.connection.TcpChannelHub# subscribe(net.openhft.chronicle.network.connection.AsyncSubscription)

Parameters:

tid - the unique id of this subscription

outBytesLock

@NotNull
public ReentrantLock outBytesLock()

closeSocket

protected void closeSocket()

closes the existing connections

isOpen

public boolean isOpen()

close

public void close()

called when we are completed finished with using the TcpChannelHub

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

nextUniqueTransaction

public long nextUniqueTransaction(long timeMs)

the transaction id are generated as unique timestamps

Parameters:

timeMs - in milliseconds

Returns:

a unique transactionId

writeSocket

public void writeSocket(@NotNull
                        net.openhft.chronicle.wire.WireOut wire)

sends data to the server via TCP/IP

Parameters:

wire - the wire containing the outbound data

proxyReply

public net.openhft.chronicle.wire.Wire proxyReply(long timeoutTime,
                                                  long tid)
                                           throws net.openhft.chronicle.bytes.ConnectionDroppedException

Throws:

net.openhft.chronicle.bytes.ConnectionDroppedException

outWire

public net.openhft.chronicle.wire.Wire outWire()

writeMetaDataStartTime

public long writeMetaDataStartTime(long startTime,
                                   @NotNull
                                   net.openhft.chronicle.wire.Wire wire,
                                   String csp,
                                   long cid)

writeMetaDataForKnownTID

public void writeMetaDataForKnownTID(long tid,
                                     @NotNull
                                     net.openhft.chronicle.wire.Wire wire,
                                     @Nullable
                                     String csp,
                                     long cid)

writeAsyncHeader

public void writeAsyncHeader(@NotNull
                             net.openhft.chronicle.wire.Wire wire,
                             String csp,
                             long cid)

The writes the meta data to wire - the async version does not contain the tid

Parameters:

wire - the wire that we will write to

csp - provide either the csp or the cid

cid - provide either the csp or the cid

lock

public boolean lock(@NotNull
                    TcpChannelHub.Task r)

lock

public boolean lock(@NotNull
                    TcpChannelHub.Task r,
                    boolean tryLock)

checkConnection

public void checkConnection()
                     throws InterruptedException

blocks until there is a connection

Throws:

InterruptedException