net.openhft.chronicle.network.connection

Interface WireOutPublisher

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

VanillaWireOutPublisher

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface WireOutPublisher
extends net.openhft.chronicle.core.io.Closeable

Author:

Rob Austin.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method and Description
default void	addWireConsumer(WireOutConsumer wireOutConsumer)
default void	applyAction(net.openhft.chronicle.bytes.Bytes out)
default void	applyAction(net.openhft.chronicle.wire.WireOut out)
default boolean	canTakeMoreData()
default void	clear()
default void	close()
default boolean	isClosed()
default boolean	isEmpty()
static WireOutPublisher	newThrottledWireOutPublisher(int periodMs, WireOutPublisher delegate) a static factory that creates and instance in chronicle enterprise
default void	publish(net.openhft.chronicle.wire.WriteMarshallable event) publishes an event without a throttle key
void	put(Object key, net.openhft.chronicle.wire.WriteMarshallable event)
default boolean	removeBytesConsumer(WireOutConsumer wireOutConsumer)
default void	wireType(net.openhft.chronicle.wire.WireType wireType)

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

closeQuietly, closeQuietly, notifyClosing

Field Detail

LOG

static final org.slf4j.Logger LOG

Method Detail

newThrottledWireOutPublisher

static WireOutPublisher newThrottledWireOutPublisher(int periodMs,
                                                     @NotNull
                                                     WireOutPublisher delegate)

a static factory that creates and instance in chronicle enterprise

Parameters:

periodMs - the period between updates of the same key

delegate - the WireOutPublisher the events will get delegated to

Returns:

a throttled WireOutPublisher

applyAction

default void applyAction(@NotNull
                         net.openhft.chronicle.bytes.Bytes out)

applyAction

default void applyAction(@NotNull
                         net.openhft.chronicle.wire.WireOut out)

addWireConsumer

default void addWireConsumer(WireOutConsumer wireOutConsumer)

removeBytesConsumer

default boolean removeBytesConsumer(WireOutConsumer wireOutConsumer)

put

void put(@Nullable
         Object key,
         net.openhft.chronicle.wire.WriteMarshallable event)

Parameters:

key - the key to the event, only used when throttling, otherwise NULL if the throttling is not required

event - the marshallable event

isClosed

default boolean isClosed()

canTakeMoreData

default boolean canTakeMoreData()

isEmpty

default boolean isEmpty()

close

default void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

wireType

default void wireType(net.openhft.chronicle.wire.WireType wireType)

clear

default void clear()

publish

default void publish(net.openhft.chronicle.wire.WriteMarshallable event)

publishes an event without a throttle key

Parameters:

event - the event to publish