net.openhft.chronicle.queue.impl

Class Excerpts.StoreAppender

java.lang.Object

net.openhft.chronicle.queue.impl.Excerpts.DefaultAppender<AbstractChronicleQueue>

net.openhft.chronicle.queue.impl.Excerpts.StoreAppender

All Implemented Interfaces:

ExcerptAppender, ExcerptCommon

Enclosing class:

Excerpts

public static class Excerpts.StoreAppender
extends Excerpts.DefaultAppender<AbstractChronicleQueue>

StoreAppender

Constructor Summary

Constructors

Constructor and Description
StoreAppender(AbstractChronicleQueue queue)

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)
long	writeBytes(net.openhft.chronicle.bytes.Bytes bytes)
long	writeBytes(net.openhft.chronicle.bytes.WriteBytesMarshallable marshallable)
long	writeDocument(net.openhft.chronicle.wire.WriteMarshallable writer)

Methods inherited from class net.openhft.chronicle.queue.impl.Excerpts.DefaultAppender

queue

Methods inherited from class java.lang.Object

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

Constructor Detail

StoreAppender

public StoreAppender(@NotNull
                     AbstractChronicleQueue queue)

Method Detail

writeDocument

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

Specified by:

writeDocument in interface ExcerptAppender

Overrides:

writeDocument in class Excerpts.DefaultAppender<AbstractChronicleQueue>

Parameters:

writer - to write to excerpt.

Returns:

the index last written or -1 if a buffered appender is being used

writeBytes

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

Parameters:

marshallable - to write to excerpt.

Returns:

the index last written or -1 if a buffered appender is being used

writeBytes

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

Specified by:

writeBytes in interface ExcerptAppender

Overrides:

writeBytes in class Excerpts.DefaultAppender<AbstractChronicleQueue>

Parameters:

bytes - to write to excerpt.

Returns:

the index last written -1 if a buffered appender is being used

index

public long index()

Specified by:

index in interface ExcerptAppender

Overrides:

index in class Excerpts.DefaultAppender<AbstractChronicleQueue>

Returns:

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

cycle

public long cycle()

Specified by:

cycle in interface ExcerptAppender

Specified by:

cycle in class Excerpts.DefaultAppender<AbstractChronicleQueue>

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)