Packages

package root

Definition Classes: root

package csw

Definition Classes: root

package messages

This project is intended to hold reusable models and messages used throughout the csw source code.

Messages

This project is intended to hold reusable models and messages used throughout the csw source code.

This also provides out of the box support to cater to the diverse communication requirements. Consumer of this library will be able to create Commands, Events, States to store ParameterSets.

Imp Packages

Commands and Events

This packages contains classes, traits and models used to create *commands* and *events*. These are all based on type-safe keys and items (a set of values with optional units). Each key has a specific type and the key's values must be of that type.

Two types of csw.messages.commands.Command are supported:

csw.messages.commands.SequenceCommand
- This commands are targeted to Sequencer. Subtypes of this are: Setup, Observe and Wait.
csw.messages.commands.ControlCommand
- This commands are targeted to Assemblies and HCD's. Subtypes of this are: Setup and Observe.

Following are the concrete commands supported by csw:

Two types of csw.messages.events.Event are supported:

Another important feature provided by *commands* package is csw.messages.commands.matchers.Matcher One of the use case for using matcher is when Assembly sends csw.messages.scaladsl.CommandMessage.Oneway command to HCD and in response to this command HCD keeps publishing its current state. Then Assembly can use Matcher with the matching definition as provided by csw.messages.commands.matchers.StateMatcher to match against the current states published by HCD.

Location and Framework

These packages contain reusable classes, traits and models. We are keeping all the models which are getting transferred over the wire and requires serialization and deserialization in csw-messages project. All the models are marked with csw.messages.TMTSerializable. csw.messages.TMTSerializable is a marker trait which extends Serializable. This is configured to use kryo serialization. Also these models are being shared between multiple projects. csw-location, csw-framework and csw-logging depends on csw-messages project which uses these models.

Location Service uses csw.messages.location.Connection model to register component/container of type:

When you resolve/find a csw.messages.location.Connection, you get csw.messages.location.Location in return which can be one of below type:

Framework package contains following actor messages:

Messages of type csw.messages.framework.PubSub are supported by PubSubActor
Below Lifecycle messages can be sent to component when component is in csw.messages.framework.SupervisorLifecycleState.Running state, note that these messages should be wrapped inside csw.messages.scaladsl.RunningMessage.Lifecycle before sending it to Supervisor actor.
- csw.messages.framework.ToComponentLifecycleMessages.GoOnline
- csw.messages.framework.ToComponentLifecycleMessages.GoOffline

Params

This package supports serialization and deserialization of commands, events and state variables in following formats:

JSON : csw.messages.params.formats.JsonSupport
Kryo : csw.messages.params.generics.ParamSetSerializer
Protobuf : package pb contains utility and directory protobuf contains proto schema files.

Scala and Java APIs

All the param and event classes are immutable. The set methods return a new instance of the object with a new item added and the get methods return an Option, in case the Key is not found. There are also value methods that return a value directly, throwing an exception if the key or value is not found.

Key Types

A set of standard key types and matching items are defined. Each key accepts one or more values of the given type.

Following csw.messages.params.generics.KeyType are supported by csw:

+--------------+-------------------------+---------------------------+
|  Primitive   |      Scala KeyType      |       Java KeyType        |
+--------------+-------------------------+---------------------------+
| Boolean      | KeyType.BooleanKey      | JKeyTypes.BooleanKey      |
| Character    | KeyType.CharKey         | JKeyTypes.JCharKey        |
| Byte         | KeyType.ByteKey         | JKeyTypes.ByteKey         |
| Short        | KeyType.ShortKey        | JKeyTypes.ShortKey        |
| Long         | KeyType.LongKey         | JKeyTypes.LongKey         |
| Int          | KeyType.IntKey          | JKeyTypes.IntKey          |
| Float        | KeyType.FloatKey        | JKeyTypes.FloatKey        |
| Double       | KeyType.DoubleKey       | JKeyTypes.DoubleKey       |
| String       | KeyType.StringKey       | JKeyTypes.StringKey       |
| Timestamp    | KeyType.TimestampKey    | JKeyTypes.TimestampKey    |
| ----------   | ----------              | ----------                |
| ByteArray    | KeyType.ByteArrayKey    | JKeyTypes.ByteArrayKey    |
| ShortArray   | KeyType.ShortArrayKey   | JKeyTypes.ShortArrayKey   |
| LongArray    | KeyType.LongArrayKey    | JKeyTypes.LongArrayKey    |
| IntArray     | KeyType.IntArrayKey     | JKeyTypes.IntArrayKey     |
| FloatArray   | KeyType.FloatArrayKey   | JKeyTypes.FloatArrayKey   |
| DoubleArray  | KeyType.DoubleArrayKey  | JKeyTypes.DoubleArrayKey  |
| ----------   | ----------              | ----------                |
| ByteMatrix   | KeyType.ByteMatrixKey   | JKeyTypes.ByteMatrixKey   |
| ShortMatrix  | KeyType.ShortMatrixKey  | JKeyTypes.ShortMatrixKey  |
| LongMatrix   | KeyType.LongMatrixKey   | JKeyTypes.LongMatrixKey   |
| IntMatrix    | KeyType.IntMatrixKey    | JKeyTypes.IntMatrixKey    |
| FloatMatrix  | KeyType.FloatMatrixKey  | JKeyTypes.FloatMatrixKey  |
| DoubleMatrix | KeyType.DoubleMatrixKey | JKeyTypes.DoubleMatrixKey |
| ----------   | ----------              | ----------                |
| Choice       | KeyType.ChoiceKey       | JKeyTypes.ChoiceKey       |
| RaDec        | KeyType.RaDecKey        | JKeyTypes.RaDecKey        |
| Struct       | KeyType.StructKey       | JKeyTypes.StructKey       |
+--------------+-------------------------+---------------------------+

Detailed information about creating Keys and Parameters can be found here: https://tmtsoftware.github.io/csw-prod/services/messages/keys-parameters.html

Detailed information about creating commands can be found here: https://tmtsoftware.github.io/csw-prod/services/messages/commands.html

Detailed information about creating events can be found here: https://tmtsoftware.github.io/csw-prod/services/messages/events.html

Definition Classes: csw

package commands

Definition Classes: messages

package commons

Definition Classes: messages

package events

Definition Classes: messages

package framework

Definition Classes: messages

package javadsl

Definition Classes: messages

package location

Definition Classes: messages

AkkaLocation

ComponentId

ComponentType

Connection

ConnectionInfo

ConnectionType

HttpLocation

Location

LocationRemoved

LocationUpdated

TcpLocation

TrackingEvent

TypedConnection

package params

Definition Classes: messages

package scaladsl

Definition Classes: messages

csw.messages

location

package location

Ordering

Alphabetic

Visibility

Public
All

Type Members

final case class AkkaLocation(connection: AkkaConnection, maybePrefix: Option[String], uri: URI, actorRef: ActorRef[Nothing], logAdminActorRef: ActorRef[Nothing]) extends Location with Product with Serializable
Represents a live Akka connection of an Actor
Represents a live Akka connection of an Actor
connection
represents a connection based on a componentId and the type of connection offered by the component
maybePrefix
an optional prefix of the component. In case of container this option remains none.
uri
represents the URI of the component. URI is not significant for AkkaLocation as actorRef serves the purpose of exposed remote address of component.
actorRef
gateway or router for a component that other components will resolve and talk to
logAdminActorRef
handles dynamic log level changes for that component

Note
Do not directly access actorRef from constructor, use one of component() or containerRef() method to get the correctly typed actor reference.
case class ComponentId extends TMTSerializable with Product with Serializable
Represents a component based on its name and type.
Represents a component based on its name and type.
Note
Name should not contain
leading or trailing spaces
and hyphen (-)
sealed abstract class ComponentType extends EnumEntry with Lowercase with TMTSerializable
Represents a type of the Component.
Represents a type of the Component. It should be serializable since it has to be transmittable over the network. The type will always be represented in lower case.
sealed abstract class Connection extends TMTSerializable
Represents a connection based on a componentId and the type of connection offered by the component
case class ConnectionInfo extends Product with Serializable
ConnectionInfo represents a component name, component type and connection type
sealed abstract class ConnectionType extends EnumEntry with TMTSerializable
Represents a type of connection offered by the Component
final case class HttpLocation(connection: HttpConnection, uri: URI, logAdminActorRef: ActorRef[Nothing]) extends Location with Product with Serializable
Represents a live Http connection
Represents a live Http connection
connection
represents a connection based on a componentId and the type of connection offered by the component
uri
represents the remote URI of the component that other components will resolve and talk to
logAdminActorRef
handles dynamic log level changes for that component
sealed abstract class Location extends TMTSerializable
Location represents a live Connection along with its URI
case class LocationRemoved extends TrackingEvent with Product with Serializable
This event represents unavailability of a location
case class LocationUpdated extends TrackingEvent with Product with Serializable
This event represents modification in location details
final case class TcpLocation(connection: TcpConnection, uri: URI, logAdminActorRef: ActorRef[Nothing]) extends Location with Product with Serializable
Represents a live Tcp connection
Represents a live Tcp connection
connection
represents a connection based on a componentId and the type of connection offered by the component
uri
represents the remote URI of the component that other components will resolve and talk to
logAdminActorRef
handles dynamic log level changes for that component
sealed abstract class TrackingEvent extends AnyRef
TrackingEvent is used to represent location events while tracking the connection
sealed abstract class TypedConnection[T <: Location] extends Connection
TypedConnection captures the type of Location that concrete connection will resolve to
TypedConnection captures the type of Location that concrete connection will resolve to
T
represents the type of Location

Value Members

object ComponentId extends Serializable
object ComponentType extends Enum[ComponentType] with PlayJsonEnum[ComponentType] with Serializable
object Connection extends Serializable
object ConnectionType extends Enum[ConnectionType] with PlayJsonEnum[ConnectionType] with Serializable

Packages

Messages

Imp Packages

Commands and Events

Location and Framework

Params

Scala and Java APIs

Key Types

location 

package location

Type Members

Value Members

Ungrouped

location