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

The TcpChannelHub is used to send your messages to the server and then read the servers response. The TcpChannelHub ensures that each response is marshalled back onto the appropriate client thread. It does this through the use of a unique transaction ID ( we call this transaction ID the "tid" ), when the server responds to the client, its expected that the server sends back the tid as the very first field in the message. The TcpChannelHub will look at each message and read the tid, and then marshall the message onto your appropriate client thread. 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	TCP_BUFFER

Constructor Summary

Constructors

Constructor and Description
TcpChannelHub(SessionProvider sessionProvider, net.openhft.chronicle.core.threads.EventLoop eventLoop, net.openhft.chronicle.wire.WireType wireType, String name, SocketAddressSupplier socketAddressSupplier, boolean shouldSendCloseMessage, ClientConnectionMonitor clientConnectionMonitor, net.openhft.chronicle.core.threads.HandlerPriority monitor, ConnectionStrategy connectionStrategy)

Method Summary

Modifier and Type	Method and Description
static void	assertAllHubsClosed()
void	checkConnection() blocks until there is a connection
void	close() called when we are completed finished with using the TcpChannelHub
static void	closeAllHubs()
void	forceDisconnect() you are unlikely to want to call this method in a production environment the purpose of this method is to simulate a network outage
boolean	isClosed()
boolean	isOpen()
boolean	isOutBytesEmpty()
boolean	isOutBytesLocked()
boolean	lock(TcpChannelHub.Task r)
boolean	lock2(TcpChannelHub.Task r, boolean reconnectOnFailure, TryLock tryLock)
long	nextUniqueTransaction(long timeMs) the transaction id are generated as unique timestamps
void	notifyClosing()
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 upon reconnection.
net.openhft.chronicle.wire.Wire	proxyReply(long timeoutTime, long tid) blocks for a message with the appropriate tid
void	subscribe(net.openhft.chronicle.network.connection.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.
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, boolean reconnectOnFailure) 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, closeQuietly

Field Detail

TCP_BUFFER

public static final int TCP_BUFFER

Constructor Detail

TcpChannelHub

public TcpChannelHub(@Nullable
                     SessionProvider sessionProvider,
                     @NotNull
                     net.openhft.chronicle.core.threads.EventLoop eventLoop,
                     @NotNull
                     net.openhft.chronicle.wire.WireType wireType,
                     @NotNull
                     String name,
                     @NotNull
                     SocketAddressSupplier socketAddressSupplier,
                     boolean shouldSendCloseMessage,
                     @Nullable
                     ClientConnectionMonitor clientConnectionMonitor,
                     @NotNull
                     net.openhft.chronicle.core.threads.HandlerPriority monitor,
                     @NotNull
                     ConnectionStrategy connectionStrategy)

Method Detail

assertAllHubsClosed

public static void assertAllHubsClosed()

closeAllHubs

public static void closeAllHubs()

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 upon reconnection.

Parameters:

tid - unique transaction id

toString

@NotNull
public String toString()

Overrides:

toString in class Object

subscribe

public void subscribe(@NotNull
                      net.openhft.chronicle.network.connection.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

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()

isOpen

public boolean isOpen()

isClosed

public boolean isClosed()

notifyClosing

public void notifyClosing()

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,
                        boolean reconnectOnFailure)

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,
                                                  TimeoutException

blocks for a message with the appropriate tid

Parameters:

timeoutTime - the amount of time to wait ( in MS ) before a time out exceptions

tid - the tid of the message that we are waiting for

Returns:

the wire of the message with the tid

Throws:

net.openhft.chronicle.bytes.ConnectionDroppedException

TimeoutException

outWire

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

isOutBytesLocked

public boolean isOutBytesLocked()

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)

lock2

public boolean lock2(@NotNull
                     TcpChannelHub.Task r,
                     boolean reconnectOnFailure,
                     @NotNull
                     TryLock tryLock)

checkConnection

public void checkConnection()

blocks until there is a connection

forceDisconnect

public void forceDisconnect()

you are unlikely to want to call this method in a production environment the purpose of this method is to simulate a network outage

isOutBytesEmpty

public boolean isOutBytesEmpty()