com.devexperts.qd

Interface SubscriptionIterator

All Known Implementing Classes:

RecordBuffer, RecordSource, SubscriptionBuffer

public interface SubscriptionIterator

The SubscriptionIterator provides serial access to subscription. It follows the same pattern as DataIterator except it does not go through data fields.

NOTE: This interface is formally unrelated to its data analogue to enforce strict type safety; also their state diagrams are not compatible.

Legacy interface

FUTURE DEPRECATION NOTE: New code shall not implement this interface due to its complexity and inherent slowness. Implement RecordSource or use RecordBuffer as a high-performance implementation of it. New code is also discouraged from using this interface unless it is need for interoperability with legacy code. Various legacy APIs will be gradually migrated to NG interfaces and classes.

Field Summary

Fields

Modifier and Type	Field and Description
static SubscriptionIterator	VOID

Method Summary

Modifier and Type	Method and Description
int	getCipher() Returns cipher for the current record returned by last call to nextRecord().
String	getSymbol() Returns symbol for the current record returned by last call to nextRecord().
long	getTime() Returns time for the current record returned by last call to nextRecord().
DataRecord	nextRecord() Returns next record.

Field Detail

VOID

static final SubscriptionIterator VOID

Method Detail

getCipher

int getCipher()

Returns cipher for the current record returned by last call to nextRecord(). Returns 0 if not encoded or if no current record is being iterated.

getSymbol

String getSymbol()

Returns symbol for the current record returned by last call to nextRecord(). Returns null if encoded or if no current record is being iterated.

getTime

long getTime()

Returns time for the current record returned by last call to nextRecord(). Returns 0 if not historical or if no current record is being iterated.

nextRecord

DataRecord nextRecord()

Returns next record. Returns null if no more records available.