net.openhft.chronicle.wire

Interface SourceContext

All Known Subinterfaces:

DocumentContext, ReadDocumentContext, WriteDocumentContext

All Known Implementing Classes:

BinaryReadDocumentContext, BinaryWriteDocumentContext, DocumentContextHolder, NoDocumentContext, TextReadDocumentContext, TextWriteDocumentContext, WrappedDocumentContext

public interface SourceContext

This is the SourceContext interface. It defines methods to interact with the underlying source context, particularly in terms of accessing its source ID and the last read index. Implementations of this interface are expected to handle source contexts which could be used in various scenarios like I/O operations, data streaming, or context management.

Method Summary

Modifier and Type	Method and Description
long	index() Obtains the index of the last read operation from this source context.
int	sourceId() Retrieves the source ID associated with this context.

Method Detail

sourceId

int sourceId()

Retrieves the source ID associated with this context. A unique identifier that represents the source from which data or operations might be fetched or to which data might be written. If a valid source ID has not been established or isn't available, it defaults to returning -1.

Returns:

The unique identifier for this source context, or -1 if not available.

index

long index()
    throws net.openhft.chronicle.core.io.IORuntimeException

Obtains the index of the last read operation from this source context. This is particularly useful to track the reading progress and can act as a checkpoint or reference point. Note: This method is specifically intended for read contexts and might not be relevant for other context types.

Returns:

The index corresponding to the last read operation.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if any issue arises while fetching the index.