net.openhft.chronicle.network.api

Interface TcpHandler<N extends NetworkContext<N>>

All Superinterfaces:

AutoCloseable, ClientClosedProvider, Closeable, net.openhft.chronicle.core.io.QueryCloseable

All Known Implementing Classes:

CspTcpHandler, HeaderTcpHandler, MethodTcpHandler, SslDelegatingTcpHandler, UberHandler, WireTcpHandler, WireTypeSniffingTcpHandler

public interface TcpHandler<N extends NetworkContext<N>>
extends ClientClosedProvider, net.openhft.chronicle.core.io.Closeable

Method Summary

Modifier and Type	Method and Description
default boolean	hasTimedOut() Check if an application-layer timeout has occurred, if this returns true, the current connection will be dropped and a reconnection attempt will be made
default void	onEndOfConnection(boolean heartbeatTimeOut)
default void	onReadTime(long readTimeNS, ByteBuffer inBB, int position, int limit)
default void	onWriteTime(long writeTimeNS, ByteBuffer byteBuffer, int start, int position)
default void	performIdleWork() Perform any low priority work, called when the handler is not busy, or after it has been busy for a long time.
void	process(@NotNull net.openhft.chronicle.bytes.Bytes<?> in, @NotNull net.openhft.chronicle.bytes.Bytes<?> out, N nc) The server reads the bytes in from the client and sends a response out back to the client.
default void	sendHeartBeat(net.openhft.chronicle.bytes.Bytes<?> out, SessionDetailsProvider sessionDetails)

Methods inherited from interface net.openhft.chronicle.network.ClientClosedProvider

hasClientClosed

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

close, closeQuietly, closeQuietly

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

isClosed, isClosing

Method Detail

process

void process(@NotNull
             @NotNull net.openhft.chronicle.bytes.Bytes<?> in,
             @NotNull
             @NotNull net.openhft.chronicle.bytes.Bytes<?> out,
             N nc)

The server reads the bytes in from the client and sends a response out back to the client.

Parameters:

in - the bytes send from the client

out - the response send back to the client

sendHeartBeat

default void sendHeartBeat(net.openhft.chronicle.bytes.Bytes<?> out,
                           SessionDetailsProvider sessionDetails)

onEndOfConnection

default void onEndOfConnection(boolean heartbeatTimeOut)

onReadTime

default void onReadTime(long readTimeNS,
                        ByteBuffer inBB,
                        int position,
                        int limit)

onWriteTime

default void onWriteTime(long writeTimeNS,
                         ByteBuffer byteBuffer,
                         int start,
                         int position)

performIdleWork

default void performIdleWork()

Perform any low priority work, called when the handler is not busy, or after it has been busy for a long time.

hasTimedOut

default boolean hasTimedOut()

Check if an application-layer timeout has occurred, if this returns true, the current connection will be dropped and a reconnection attempt will be made