Package com.couchbase.client.dcp.highlevel

Class StreamOffset

java.lang.Object

com.couchbase.client.dcp.highlevel.StreamOffset

public class StreamOffset
extends Object

Position in a DCP stream for a particular vbucket.

Field Summary

Fields

Modifier and Type	Field	Description
static final StreamOffset	ZERO

Constructor Summary

Constructors

Constructor	Description
StreamOffset(long vbuuid, long seqno, SnapshotMarker snapshot, long collectionsManifestUid)

Method Summary

Modifier and Type	Method	Description
static String	describe(StreamOffset offset)	Returns the same info as toString(), but in a format readable by humans without special knowledge.
boolean	equals(Object o)
long	getCollectionsManifestUid()
long	getSeqno()	NOTE: Sequence numbers are unsigned, and must be compared using Long.compareUnsigned(long, long)
SnapshotMarker	getSnapshot()
long	getVbuuid()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

ZERO

public static final StreamOffset ZERO

Constructor Details

StreamOffset

public StreamOffset(long vbuuid,
 long seqno,
 SnapshotMarker snapshot,
 long collectionsManifestUid)

Parameters:

collectionsManifestUid - pass zero if client is not collections-aware or if no UID is available.

Method Details

getVbuuid

public long getVbuuid()

getSeqno

public long getSeqno()

NOTE: Sequence numbers are unsigned, and must be compared using Long.compareUnsigned(long, long)

getSnapshot

public SnapshotMarker getSnapshot()

getCollectionsManifestUid

public long getCollectionsManifestUid()

toString

public String toString()

Overrides:

toString in class Object

describe

public static String describe(@Nullable
 StreamOffset offset)

Returns the same info as toString(), but in a format readable by humans without special knowledge.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object