Packages

  • package root
    Definition Classes
    root
  • package csw
    Definition Classes
    root
  • package event
    Definition Classes
    csw
  • package client

    This module implements an Event Service responsible for publishing an csw.params.events.Event or subscribing to an csw.params.events.Event.

    Event Service

    This module implements an Event Service responsible for publishing an csw.params.events.Event or subscribing to an csw.params.events.Event. An event is published on a csw.params.events.EventKey. The event key is composed of a csw.prefix.models.Prefix depicting the source and an csw.params.events.EventName. The subscriber can subscribe to the csw.params.events.EventKey to receive all events published on the Key.

    Example: Event Service
    val eventServiceFactory          = new EventServiceFactory()
    val eventService: EventService   = eventServiceFactory.make(locationService)

    Using above code, you can create instance of csw.event.api.scaladsl.EventService. EventService is the factory to create publishers and subscribers.

    You can choose to use defaultPublisher in case you want to share same connection for publishing different events.

    Example: Event Publisher

    Event Publisher provides asynchronous APIs to publish one or more Events

    val event = SystemEvent(prefix, EventName("filter_wheel"))
    
    val publisher    = eventService.defaultPublisher
    publisher.publish(event)
    Example: Event Subscriber (subscribe and get API)

    Event Subscriber provides asynchronous APIs to subscribe to one or more Event Keys. It also provides APIs to subscribe using a pattern. In addition, there are APIs to get latest events for one ore more Event Keys without making a subscription

    The EventSubscriber provides various API's to subscribe to csw.params.events.EventKey. One of such a subscribe method takes an ActorRef of an arbitrary actor or a callback function to be called when an event matching the given csw.params.events.EventKey is received. In the example below, we only provide the callback argument value. You could also provide an ActorRef of some actor that should receive the Event message.

     def callback(ev: Event): Unit = {
       // ...
     }
    
     async {
       val subscriber    = eventService.defaultSubscriber
       subscriber.subscribeCallback(Set(EventKey(prefix, EventName("filter_wheel"))), callback)
    
       val event = await(subscriber.get(event.eventKey))
    
       event match {
         case e: ObserveEvent => assert(e.prefix == expectedPrefix)
         case _               => fail("Expected ObserveEvent")
       }
    }

    csw provides two implementations for Event Service which can be accessed through csw-event-client : 1. RedisEventService - Redis as event store and publisher/subscriber functionality 2. KafkaEventService - Kafka as event store and publisher/subscriber functionality

    Complete guide of usage of different API's provided by EventService is available at: https://tmtsoftware.github.io/csw/services/event.html

    Definition Classes
    event
  • package models
    Definition Classes
    client
  • object EventStores

    Event service supports two underlying implementations for event store 1.

    Event service supports two underlying implementations for event store 1. csw.event.client.models.EventStores.RedisStore: This is the default and recommended store. If you are creating csw.event.api.scaladsl.EventService using csw.event.client.EventServiceFactory, then you should shutdown redis client when it is no longer in use. 2. csw.event.client.models.EventStores.KafkaStore: This can be used to create an csw.event.api.scaladsl.EventService which is backed by Kafka event store. You should not use this unless you have strong reasons to do so.

    Definition Classes
    models
    Note

    If you are using csw-framework, your component will already have an event service injected which is backed up by csw.event.client.models.EventStores.RedisStore. You do not need to take the csw.event.client.EventServiceFactory route.

  • KafkaStore
  • RedisStore

case object KafkaStore extends EventStore with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KafkaStore
  2. Serializable
  3. Product
  4. Equals
  5. EventStore
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. def productElementName(n: Int): String
    Definition Classes
    Product
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from EventStore

Inherited from AnyRef

Inherited from Any

Ungrouped