net.openhft.chronicle.network.api.session

Interface SubHandler<T extends NetworkContext<T>>

All Superinterfaces:

AutoCloseable, Closeable, net.openhft.chronicle.core.io.ManagedCloseable, NetworkContextManager<T>, net.openhft.chronicle.core.io.QueryCloseable

All Known Subinterfaces:

WritableSubHandler<T>

All Known Implementing Classes:

AbstractSubHandler, HeartbeatHandler, NoOpHandler

public interface SubHandler<T extends NetworkContext<T>>
extends NetworkContextManager<T>, net.openhft.chronicle.core.io.ManagedCloseable

Method Summary

Modifier and Type	Method and Description
long	cid()
void	cid(long cid)
net.openhft.chronicle.core.io.Closeable	closable()
void	closeable(net.openhft.chronicle.core.io.Closeable closeable)
String	csp()
void	csp(@NotNull String cspText)
default boolean	inProgress() Is a long-lived action (see above) in progress?
void	localIdentifier(int localIdentifier)
void	onInitialize(net.openhft.chronicle.wire.WireOut outWire) called after all the construction and configuration has completed
void	onRead(@NotNull net.openhft.chronicle.wire.WireIn inWire, @NotNull net.openhft.chronicle.wire.WireOut outWire)
default boolean	onTouch(net.openhft.chronicle.wire.WireOut outWire) Some events may result in long-lived actions, which must yield periodically to allow (eg) buffers to clear (out messages to be sent) A busy handler can indicate a long-lived action by returning true from inProgress The caller should then use this to invoke onTouch to give the handler another slice
void	remoteIdentifier(int remoteIdentifier)

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

nc, nc

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

createdHere, throwExceptionIfClosed, warnAndCloseIfNotClosed

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

cid

void cid(long cid)

cid

long cid()

csp

void csp(@NotNull
         @NotNull String cspText)

csp

String csp()

onRead

void onRead(@NotNull
            @NotNull net.openhft.chronicle.wire.WireIn inWire,
            @NotNull
            @NotNull net.openhft.chronicle.wire.WireOut outWire)

closable

net.openhft.chronicle.core.io.Closeable closable()

remoteIdentifier

void remoteIdentifier(int remoteIdentifier)

localIdentifier

void localIdentifier(int localIdentifier)

onInitialize

void onInitialize(net.openhft.chronicle.wire.WireOut outWire)
           throws RejectedExecutionException

called after all the construction and configuration has completed

Parameters:

outWire - allow data to be written

Throws:

RejectedExecutionException

onTouch

default boolean onTouch(net.openhft.chronicle.wire.WireOut outWire)

Some events may result in long-lived actions, which must yield periodically to allow (eg) buffers to clear (out messages to be sent) A busy handler can indicate a long-lived action by returning true from inProgress The caller should then use this to invoke onTouch to give the handler another slice

Parameters:

outWire -

Returns:

- true if the long-lived action is complete; false if there's more to do

inProgress

default boolean inProgress()

Is a long-lived action (see above) in progress?

Returns:

- true if long-lived action in progress; else false

closeable

void closeable(net.openhft.chronicle.core.io.Closeable closeable)