Package com.qtsurfer.api.sdk

Record Class LiveSignalHistory

java.lang.Object

java.lang.Record

com.qtsurfer.api.sdk.LiveSignalHistory

public record LiveSignalHistory(List<LiveSignalHistory.Publication> publications, String epoch, long offset)
extends Record

Sandbox signals still held by a subscribed live WebSocket channel, oldest first.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	LiveSignalHistory.Position	A channel stream position, valid only while its epoch remains available.
static final record	LiveSignalHistory.Publication	A decoded signal and the offset it carried when published.

Constructor Summary

Constructors

Constructor	Description
LiveSignalHistory(List<LiveSignalHistory.Publication> publications, String epoch, long offset)	Creates an instance of a LiveSignalHistory record class.

Method Summary

Modifier and Type	Method	Description
String	epoch()	Returns the value of the epoch record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
long	offset()	Returns the value of the offset record component.
LiveSignalHistory.Position	position()	Position after the last returned signal, or the channel's current position when empty.
List<LiveSignalHistory.Publication>	publications()	Returns the value of the publications record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LiveSignalHistory

public LiveSignalHistory(List<LiveSignalHistory.Publication> publications,
 String epoch,
 long offset)

Creates an instance of a LiveSignalHistory record class.

Parameters:

publications - the value for the publications record component

epoch - the value for the epoch record component

offset - the value for the offset record component

Method Details

position

public LiveSignalHistory.Position position()

Position after the last returned signal, or the channel's current position when empty. This avoids skipping publications when a limit smaller than the held history is used.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

publications

public List<LiveSignalHistory.Publication> publications()

Returns the value of the publications record component.

Returns:

the value of the publications record component

epoch

public String epoch()

Returns the value of the epoch record component.

Returns:

the value of the epoch record component

offset

public long offset()

Returns the value of the offset record component.

Returns:

the value of the offset record component