net.openhft.chronicle.queue.impl

Class Excerpts.BufferedAppender

java.lang.Object

net.openhft.chronicle.queue.impl.Excerpts.BufferedAppender

All Implemented Interfaces:

ExcerptAppender, ExcerptCommon

Enclosing class:

Excerpts

public static class Excerpts.BufferedAppender
extends Object
implements ExcerptAppender

Unlike the other appenders the write methods are not able to return the index that he exceprt was written to, as the write is deferred using a ring buffer , and later written using a background thread

Author:

Rob Austin.

Constructor Summary

Constructors

Constructor and Description
BufferedAppender(net.openhft.chronicle.threads.api.EventLoop eventLoop, Excerpts.StoreAppender underlyingAppender, long ringBufferCapacity, java.util.function.Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> ringBufferStats)

Method Summary

Modifier and Type	Method and Description
long	cycle()
long	index()
void	prefetch() Hint to the underlying store to get the next page(s)
net.openhft.chronicle.bytes.BytesRingBuffer	ringBuffer()
long	writeBytes(net.openhft.chronicle.bytes.Bytes<?> bytes) for the best performance call this method, rather than net.openhft.chronicle.queue.impl.Excerpts.BufferedAppender#writeBytes(net.openhft.chronicle.bytes.WriteBytesMarshallable) or net.openhft.chronicle.queue.impl.Excerpts.BufferedAppender#writeDocument(net.openhft.chronicle.wire.WriteMarshallable)
long	writeBytes(net.openhft.chronicle.bytes.WriteBytesMarshallable marshallable) for the best performacne use net.openhft.chronicle.queue.impl.Excerpts.BufferedAppender#writeBytes(net.openhft.chronicle.bytes.Bytes)
long	writeDocument(net.openhft.chronicle.wire.WriteMarshallable writer) for the best performance use net.openhft.chronicle.queue.impl.Excerpts.BufferedAppender#writeBytes(net.openhft.chronicle.bytes.Bytes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BufferedAppender

public BufferedAppender(@NotNull
                        net.openhft.chronicle.threads.api.EventLoop eventLoop,
                        @NotNull
                        Excerpts.StoreAppender underlyingAppender,
                        long ringBufferCapacity,
                        @NotNull
                        java.util.function.Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> ringBufferStats)

Method Detail

ringBuffer

@NotNull
public net.openhft.chronicle.bytes.BytesRingBuffer ringBuffer()

writeDocument

public long writeDocument(@NotNull
                          net.openhft.chronicle.wire.WriteMarshallable writer)

for the best performance use net.openhft.chronicle.queue.impl.Excerpts.BufferedAppender#writeBytes(net.openhft.chronicle.bytes.Bytes)

Specified by:

writeDocument in interface ExcerptAppender

Parameters:

writer - to write to excerpt.

Returns:

always returns -1 when using the buffered appender

writeBytes

public long writeBytes(@NotNull
                       net.openhft.chronicle.bytes.WriteBytesMarshallable marshallable)

for the best performacne use net.openhft.chronicle.queue.impl.Excerpts.BufferedAppender#writeBytes(net.openhft.chronicle.bytes.Bytes)

Specified by:

writeBytes in interface ExcerptAppender

Parameters:

marshallable - to write to excerpt.

Returns:

always returns -1 when using the buffered appender

writeBytes

public long writeBytes(@NotNull
                       net.openhft.chronicle.bytes.Bytes<?> bytes)

for the best performance call this method, rather than net.openhft.chronicle.queue.impl.Excerpts.BufferedAppender#writeBytes(net.openhft.chronicle.bytes.WriteBytesMarshallable) or net.openhft.chronicle.queue.impl.Excerpts.BufferedAppender#writeDocument(net.openhft.chronicle.wire.WriteMarshallable)

Specified by:

writeBytes in interface ExcerptAppender

Parameters:

bytes - to write to excerpt.

Returns:

always returns -1 when using the buffered appender

Throws:

IOException

index

public long index()

Specified by:

index in interface ExcerptAppender

Returns:

the index last written, this index includes the cycle and the sequence number

cycle

public long cycle()

Specified by:

cycle in interface ExcerptAppender

Returns:

the cycle this appender is on, unusually with chronicle-queue each cycle will have its own unique data file to store the excerpt

prefetch

public void prefetch()

Description copied from interface: ExcerptCommon

Hint to the underlying store to get the next page(s)

Specified by:

prefetch in interface ExcerptCommon