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

Interface for accessing metadata about the origin of a message.

It exposes the source identifier and position of the current document. A DocumentContext may implement this interface to provide traceability of a message to its queue index and source ID.

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:

unique identifier for this context, or -1 if not available or not applicable

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:

index of the current entry, for example the queue index

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if the index cannot be determined