public static class Subscriber.CompleteOnEmpty<V> extends Object implements Subscriber.Option<V,V>, ExternalizableLite, PortableObject
CompletableFuture
returned
from the Subscriber.receive()
operation should complete with a null Subscriber.Element
upon identifying that the topic is or has become empty. Without this option the
future will not complete until a new value becomes available. It is supported for this
option to differ between members of the same subscriber group.Modifier and Type | Field and Description |
---|---|
protected static Subscriber.CompleteOnEmpty |
INSTANCE
The CompleteOnEmpty singleton.
|
Constructor and Description |
---|
CompleteOnEmpty()
Default constructor for serialization.
|
Modifier and Type | Method and Description |
---|---|
static <V> Subscriber.CompleteOnEmpty<V> |
enabled()
Obtain the Option indicating futures should complete if the topic is empty.
|
void |
readExternal(DataInput in)
Restore the contents of this object by loading the object's state from
the passed DataInput object.
|
void |
readExternal(PofReader in)
Restore the contents of a user type instance by reading its state using
the specified PofReader object.
|
void |
writeExternal(DataOutput out)
Save the contents of this object by storing the object's state into
the passed DataOutput object.
|
void |
writeExternal(PofWriter out)
Save the contents of a POF user type instance by writing its state using
the specified PofWriter object.
|
protected static final Subscriber.CompleteOnEmpty INSTANCE
public void readExternal(DataInput in) throws IOException
ExternalizableLite
readExternal
in interface ExternalizableLite
in
- the DataInput stream to read data from in order to restore
the state of this objectIOException
- if an I/O exception occursNotActiveException
- if the object is not in its initial
state, and therefore cannot be deserialized intopublic void writeExternal(DataOutput out) throws IOException
ExternalizableLite
writeExternal
in interface ExternalizableLite
out
- the DataOutput stream to write the state of this object toIOException
- if an I/O exception occurspublic void readExternal(PofReader in) throws IOException
PortableObject
readExternal
in interface PortableObject
in
- the PofReader from which to read the object's stateIOException
- if an I/O error occurspublic void writeExternal(PofWriter out) throws IOException
PortableObject
writeExternal
in interface PortableObject
out
- the PofWriter to which to write the object's stateIOException
- if an I/O error occurspublic static <V> Subscriber.CompleteOnEmpty<V> enabled()