Packages

  • package root
    Definition Classes
    root
  • package csw
    Definition Classes
    root
  • package command
    Definition Classes
    csw
  • package client

    This project defines the basic classes and traits for the Command Service.

    Command Service

    This project defines the basic classes and traits for the Command Service.

    Related projects are: - csw-messages:

    • This defines the types of command (Oneway/Submit etc.) and types of configurations (Setup/Observe/Wait etc.)
    • Complete usage of Messages is available at: https://tmtsoftware.github.io/csw/services/messages.html

    - framework:

    • This defines the Hcd and Assembly handlers, lifecycle manager and supervisor for components.
    • Framework allows component writer to override onValidation, onSubmit and onOneway handlers. (Note it allows overriding other handlers as well.)
    • On every command received by component, onValidation handler gets invoked where received command gets validated and validation response is returned.
    • Based on validation response and command type, onSubmit/onOneway hooks gets invoked where command gets processed.
    • Complete details of handling commands can be found here : https://tmtsoftware.github.io/csw/framework/handling-lifecycle.html#handling-commands

    Important classes in this project are:

    - csw.command.api.scaladsl.CommandService

    This class wraps the csw.location.api.models.AkkaLocation and provides helpers to send commands to component actor extracted from provided location. Normal component writers workflow would be to first resolve component using location service and then create CommandService instance using resolved location.

    Using this instance, you can Submit Command/Commands to other component or query for command result or subscribe for long running command result.

    When you have multiple commands targeted to multiple components then you can use ConfigDistributor. Using CommandDistributor utility you can send all these commands in one go and get aggregated response.

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

    Definition Classes
    command
  • package models
    Definition Classes
    client
  • package framework
    Definition Classes
    models
  • Component
  • ComponentInfo
  • Components
  • ContainerLifecycleState
  • LifecycleStateChanged
  • LocationServiceUsage
  • LockingResponse
  • PubSub
  • SupervisorLifecycleState
  • ToComponentLifecycleMessage

object PubSub

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PubSub
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class Publish[T](data: T) extends PublisherMessage[T] with Product with Serializable

    Represents a publish action

    Represents a publish action

    T

    represents the type of data that is published

    data

    of type T that gets published

  2. sealed trait PublisherMessage[T] extends PubSub[T]

    Represents the messages about publishing data e.g Publish

    Represents the messages about publishing data e.g Publish

    T

    represents the type of data that is published

  3. case class Subscribe[T](ref: ActorRef[T]) extends SubscriberMessage[T] with Product with Serializable

    Represents the subscribe action where all the current state publishing from the particular component can be subscribed to

    Represents the subscribe action where all the current state publishing from the particular component can be subscribed to

    T

    represents the type of data that is subscribed

    ref

    the reference of subscriber used to notify to when some data is published

  4. case class SubscribeOnly[T](ref: ActorRef[T], names: Set[StateName]) extends SubscriberMessage[T] with Product with Serializable

    Represents the subscribe action for current states specified by a set of stateNames

    Represents the subscribe action for current states specified by a set of stateNames

    T

    represents the type of data that is subscribed

    ref

    the reference of subscriber used to notify to when some data is published

    names

    set of stateNames uniquely representating current states for a component

  5. sealed trait SubscriberMessage[T] extends PubSub[T]

    Represents the messages about subscribing data e.g Subscribe and Unsubscribe

    Represents the messages about subscribing data e.g Subscribe and Unsubscribe

    T

    represents the type of data that is subscribed

  6. case class Unsubscribe[T](ref: ActorRef[T]) extends SubscriberMessage[T] with Product with Serializable

    Represents a unsubscribe action

    Represents a unsubscribe action

    T

    represents the type of data that is subscribed

    ref

    the reference of subscriber that no longer wishes to receive notification for published data

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. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  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 AnyRef

Inherited from Any

Ungrouped