net.openhft.chronicle.wire

Class BinaryReadDocumentContext

java.lang.Object

net.openhft.chronicle.wire.BinaryReadDocumentContext

All Implemented Interfaces:

Closeable, AutoCloseable, DocumentContext, ReadDocumentContext, SourceContext

public class BinaryReadDocumentContext
extends Object
implements ReadDocumentContext

Field Summary

Fields

Modifier and Type	Field and Description
long	lastStart
protected boolean	notComplete
protected boolean	present
protected long	readLimit
protected long	readPosition
long	start
protected AbstractWire	wire

Constructor Summary

Constructors

Constructor and Description
BinaryReadDocumentContext(Wire wire)
BinaryReadDocumentContext(Wire wire, boolean ensureFullRead)

Method Summary

Modifier and Type	Method and Description
void	close()
void	closeReadLimit(long readLimit)
void	closeReadPosition(long readPosition)
long	index() Index last read, only available for read contexts.
boolean	isMetaData()
boolean	isNotComplete()
boolean	isPresent()
void	metaData(boolean metaData) Set the metaData flag.
protected boolean	rollback()
void	rollbackOnClose() Call this if you have detected an error condition and you want the context rolled back when it is closed, rather than half a message committed
void	setStart(long start)
int	sourceId()
void	start()
String	toString()
Wire	wire()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.wire.DocumentContext

isData

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

closeQuietly, closeQuietly, isClosed, notifyClosing

Field Detail

start

public long start

lastStart

public long lastStart

wire

@Nullable
protected AbstractWire wire

present

protected boolean present

notComplete

protected boolean notComplete

readPosition

protected long readPosition

readLimit

protected long readLimit

Constructor Detail

BinaryReadDocumentContext

public BinaryReadDocumentContext(@Nullable
                                 Wire wire)

BinaryReadDocumentContext

public BinaryReadDocumentContext(@Nullable
                                 Wire wire,
                                 boolean ensureFullRead)

Method Detail

isMetaData

public boolean isMetaData()

Specified by:

isMetaData in interface DocumentContext

Returns:

true - is the entry is of type meta data

metaData

public void metaData(boolean metaData)

Description copied from interface: DocumentContext

Set the metaData flag. When writing this will determine whether the message is written as metaData or not.

Specified by:

metaData in interface DocumentContext

Parameters:

metaData - write as metaData instead of data if true.

isPresent

public boolean isPresent()

Specified by:

isPresent in interface DocumentContext

Returns:

true - if is a document document

closeReadPosition

public void closeReadPosition(long readPosition)

Specified by:

closeReadPosition in interface ReadDocumentContext

closeReadLimit

public void closeReadLimit(long readLimit)

Specified by:

closeReadLimit in interface ReadDocumentContext

wire

@Nullable
public Wire wire()

Specified by:

wire in interface DocumentContext

Returns:

the wire of the document

rollback

protected boolean rollback()

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

start

public void start()

Specified by:

start in interface ReadDocumentContext

index

public long index()

Description copied from interface: SourceContext

Index last read, only available for read contexts.

Specified by:

index in interface SourceContext

Returns:

the current Excerpt's index

sourceId

public int sourceId()

Specified by:

sourceId in interface SourceContext

Returns:

the current source id or -1

isNotComplete

public boolean isNotComplete()

Specified by:

isNotComplete in interface DocumentContext

Returns:

whether the NOT_COMPLETE flag has been set.

rollbackOnClose

public void rollbackOnClose()

Description copied from interface: DocumentContext

Call this if you have detected an error condition and you want the context rolled back when it is closed, rather than half a message committed

Specified by:

rollbackOnClose in interface DocumentContext

setStart

public void setStart(long start)

toString

public String toString()

Overrides:

toString in class Object