net.openhft.chronicle.network.connection

Class TcpChannelHub

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.network.connection.TcpChannelHub

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked

Deprecated.

This has been moved to DataGrid without a replacement

@Deprecated
public final class TcpChannelHub
extends net.openhft.chronicle.core.io.AbstractCloseable

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	TCP_BUFFER Deprecated. Use NetworkUtil.TCP_BUFFER_SIZE instead
static int	TCP_SAFE_SIZE Deprecated. Use NetworkUtil.TCP_SAFE_SIZE instead
static boolean	TCP_USE_PADDING Deprecated. Use NetworkUtil.TCP_USE_PADDING instead

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

closedHere, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_DISCARD_WARNING, WARN_NS

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Fields inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Constructor and Description
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) Deprecated.
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, @Nullable Supplier<net.openhft.chronicle.threads.Pauser> pauserSupplier) Deprecated.

Method Summary

Modifier and Type	Method and Description
static void	assertAllHubsClosed() Deprecated.
void	checkConnection() Deprecated. blocks until there is a connection
static void	closeAllHubs() Deprecated.
void	forceDisconnect() Deprecated. 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	isOpen() Deprecated.
boolean	isOutBytesEmpty() Deprecated.
boolean	lock(@NotNull TcpChannelHub.Task r) Deprecated.
boolean	lock2(@NotNull TcpChannelHub.Task r, boolean reconnectOnFailure, @NotNull TryLock tryLock) Deprecated.
long	nextUniqueTransaction(long timeMs) Deprecated. the transaction id are generated as unique timestamps
@NotNull ReentrantLock	outBytesLock() Deprecated.
net.openhft.chronicle.wire.Wire	outWire() Deprecated.
protected void	performClose() Deprecated. called when we are finished with using the TcpChannelHub
void	preventSubscribeUponReconnect(long tid) Deprecated. 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) Deprecated. blocks for a message with the appropriate tid
static void	setTcpNoDelay(Socket socket, boolean tcpNoDelay) Deprecated.
void	subscribe(@NotNull net.openhft.chronicle.network.connection.AsyncSubscription asyncSubscription) Deprecated. 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.
@NotNull String	toString() Deprecated.
void	unsubscribe(long tid) Deprecated. closes a subscription established by net.openhft.chronicle.network.connection.TcpChannelHub# subscribe(net.openhft.chronicle.network.connection.AsyncSubscription)
void	writeAsyncHeader(@NotNull net.openhft.chronicle.wire.Wire wire, String csp, long cid) Deprecated. The writes the meta data to wire - the async version does not contain the tid
void	writeMetaDataForKnownTID(long tid, @NotNull net.openhft.chronicle.wire.Wire wire, @Nullable String csp, long cid, boolean closeMessage) Deprecated.
long	writeMetaDataStartTime(long startTime, @NotNull net.openhft.chronicle.wire.Wire wire, String csp, long cid) Deprecated.
void	writeSocket(@NotNull net.openhft.chronicle.wire.WireOut wire, boolean reconnectOnFailure, boolean sessionMessage) Deprecated. sends data to the server via TCP/IP

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable

assertCloseable, assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, disableThreadSafetyCheck, disableThreadSafetyCheck, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, resetUsedByThread, shouldPerformCloseInBackground, shouldWaitForClosed, singleThreadedCheckDisabled, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfClosed, throwExceptionIfClosedInSetter, unmonitor, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

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

referenceName, temporary

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

closeQuietly, closeQuietly

Field Detail

TCP_BUFFER

@Deprecated
public static final int TCP_BUFFER

Deprecated. Use NetworkUtil.TCP_BUFFER_SIZE instead

TCP_SAFE_SIZE

@Deprecated
public static final int TCP_SAFE_SIZE

Deprecated. Use NetworkUtil.TCP_SAFE_SIZE instead

TCP_USE_PADDING

@Deprecated
public static final boolean TCP_USE_PADDING

Deprecated. Use NetworkUtil.TCP_USE_PADDING instead

Constructor Detail

TcpChannelHub

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

Deprecated.

TcpChannelHub

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

Deprecated.

Method Detail

assertAllHubsClosed

public static void assertAllHubsClosed()

Deprecated.

closeAllHubs

public static void closeAllHubs()

Deprecated.

setTcpNoDelay

public static void setTcpNoDelay(Socket socket,
                                 boolean tcpNoDelay)
                          throws SocketException

Deprecated.

Throws:

SocketException

preventSubscribeUponReconnect

public void preventSubscribeUponReconnect(long tid)

Deprecated.

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 @NotNull String toString()

Deprecated.

Overrides:

toString in class net.openhft.chronicle.core.io.AbstractCloseable

subscribe

public void subscribe(@NotNull
                      @NotNull net.openhft.chronicle.network.connection.AsyncSubscription asyncSubscription)

Deprecated.

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)

Deprecated.

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 @NotNull ReentrantLock outBytesLock()

Deprecated.

isOpen

public boolean isOpen()

Deprecated.

performClose

protected void performClose()

Deprecated.

called when we are finished with using the TcpChannelHub

Specified by:

performClose in class net.openhft.chronicle.core.io.AbstractCloseable

nextUniqueTransaction

public long nextUniqueTransaction(long timeMs)

Deprecated.

the transaction id are generated as unique timestamps

Parameters:

timeMs - in milliseconds

Returns:

a unique transactionId

writeSocket

public void writeSocket(@NotNull
                        @NotNull net.openhft.chronicle.wire.WireOut wire,
                        boolean reconnectOnFailure,
                        boolean sessionMessage)

Deprecated.

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

Deprecated.

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

Deprecated.

writeMetaDataStartTime

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

Deprecated.

writeMetaDataForKnownTID

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

Deprecated.

writeAsyncHeader

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

Deprecated.

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
                    @NotNull TcpChannelHub.Task r)

Deprecated.

lock2

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

Deprecated.

checkConnection

public void checkConnection()

Deprecated.

blocks until there is a connection

forceDisconnect

public void forceDisconnect()

Deprecated.

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

Deprecated.