Package com.tangosol.net.topic

Class Subscriber.CompleteOnEmpty<V>

java.lang.Object
com.tangosol.net.topic.Subscriber.CompleteOnEmpty<V>
All Implemented Interfaces:
ExternalizableLite, PortableObject, Subscriber.Option<V,V>, Serializable
Enclosing interface:
Subscriber<V>
public static class Subscriber.CompleteOnEmpty<V> extends Object implements Subscriber.Option<V,V>, ExternalizableLite, PortableObject
The CompleteOnEmpty option indicates that the 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.
See Also:

  • Field Details

  • Constructor Details

    • CompleteOnEmpty

      public CompleteOnEmpty()
      Default constructor for serialization.

  • Method Details

    • readExternal

      public void readExternal(DataInput in) throws IOException
      Description copied from interface: ExternalizableLite
      Restore the contents of this object by loading the object's state from the passed DataInput object.
      Specified by:
      readExternal in interface ExternalizableLite
      Parameters:
      in - the DataInput stream to read data from in order to restore the state of this object
      Throws:
      IOException - if an I/O exception occurs

    • writeExternal

      public void writeExternal(DataOutput out) throws IOException
      Description copied from interface: ExternalizableLite
      Save the contents of this object by storing the object's state into the passed DataOutput object.
      Specified by:
      writeExternal in interface ExternalizableLite
      Parameters:
      out - the DataOutput stream to write the state of this object to
      Throws:
      IOException - if an I/O exception occurs

    • readExternal

      public void readExternal(PofReader in) throws IOException
      Description copied from interface: PortableObject
      Restore the contents of a user type instance by reading its state using the specified PofReader object.
      Specified by:
      readExternal in interface PortableObject
      Parameters:
      in - the PofReader from which to read the object's state
      Throws:
      IOException - if an I/O error occurs

    • writeExternal

      public void writeExternal(PofWriter out) throws IOException
      Description copied from interface: PortableObject
      Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
      Specified by:
      writeExternal in interface PortableObject
      Parameters:
      out - the PofWriter to which to write the object's state
      Throws:
      IOException - if an I/O error occurs

    • enabled

      public static <V> Subscriber.CompleteOnEmpty<V> enabled()
      Obtain the Option indicating futures should complete if the topic is empty.
      Returns:
      the Option indicating futures should complete if the topic is empty