Package csw.event.api.javadsl

Interface IEventSubscription

  • public interface IEventSubscription
    An interface to represent a subscription. On subscribing to one or more Event Keys using the IEventSubscriber, the subscriber gets a handle to that particular subscription so as to perform some subscription specific tasks.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.concurrent.CompletableFuture<akka.Done> ready()
      To check if the underlying subscription is ready to emit elements
      java.util.concurrent.CompletableFuture<akka.Done> unsubscribe()
      To unsubscribe a given subscription.

    • Method Detail

      • ready

        java.util.concurrent.CompletableFuture<akka.Done> ready()
        To check if the underlying subscription is ready to emit elements

        Returns:
        a future which completes when the underlying subscription is ready to emit elements

      • unsubscribe

        java.util.concurrent.CompletableFuture<akka.Done> unsubscribe()
        To unsubscribe a given subscription. This will also clean up subscription specific underlying resources

        Returns:
        a future which completes when the unsubscribe is completed