Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package cisco
    Definition Classes
    com
  • package streambed

    The base package of the Streambed library.

    The base package of the Streambed library. Of note is the com.cisco.streambed.Application suite of types. These types conveniently establish a streambed environment for an application.

    Sample usage from Java:

    /**
     * Bootstraps our application and handles signals
     */
    public class MyServerEntryPoints {
        private static ApplicationProcess applicationProcess = null;
    
        public static void main(String[] args) {
            applicationProcess = new ApplicationProcess(new MyServer());
            applicationProcess.main(args);
        }
    
        public static void trap(int signal) {
          if (applicationProcess != null) {
                applicationProcess.trap(signal);
            }
        }
    }

    ...with MyServer being declared as:

    public class MyServer extends Application {
        @Override
        public void main(String[] args, ApplicationContext context) {
          ..
        }
    }

    The equivalent in Scala:

    object MyServerEntryPoints {
      private lazy val applicationProcess = ApplicationProcess(MyServer)
    
      def main(args: Array[String]): Unit =
        applicationProcess.main(args)
    
      def trap(signal: Int): Unit =
        applicationProcess.trap(signal)
    }

    ...with MyServer being declared as:

    object MyServer extends Application {
      override def main(args: Array[String], applicationContext: ApplicationContext): Unit = {
        ..
      }
    }

    The essential idea is that a regular JVM entry point (MyServerEntryPoints), establishes a com.cisco.streambed.ApplicationProcess of a class named MyServer. The trap method is used by Landlord for whenever an operating systemm signal is sent to the process. My extending com.cisco.streambed.Application, a com.cisco.streambed.ApplicationContext is provided by Streambed, containing almost all of what an application will require in order to startup (an actor system, metrics, logging...). The resources provided within the context are also automatically released on exit.

    Definition Classes
    cisco
  • package mqttgateway

    A streambed service that can be dynamically configured to publish and subscribe to sensor events and their meta data.

    A streambed service that can be dynamically configured to publish and subscribe to sensor events and their meta data. An HTTP API is provided as a control plane.

    Definition Classes
    streambed
  • package model

    The DAO model for the MQTT gateway API

    The DAO model for the MQTT gateway API

    Definition Classes
    mqttgateway
  • CreateDownstreamTopic
  • CreateTopic
  • CreateUpstreamTopic
  • UserCredentials

package model

The DAO model for the MQTT gateway API

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

Type Members

  1. case class CreateDownstreamTopic(id: String, secretPath: Option[String], mqttCommandTopic: String, commandTopic: String, dataIsBinary: Boolean) extends CreateTopic with Product with Serializable

    ADT for creating an MQTT downstream topic

  2. sealed trait CreateTopic extends AnyRef

    ADT for creating a topic.

  3. case class CreateUpstreamTopic(id: String, secretPath: Option[String], eventTopic: String, mqttEventTopic: String, dataIsBinary: Boolean) extends CreateTopic with Product with Serializable

    ADT for creating an MQTT upstream topic

  4. case class UserCredentials(username: String, password: String) extends Product with Serializable

    ADT for logging in

Value Members

  1. object CreateTopic

Inherited from AnyRef

Inherited from Any

Ungrouped