Packages

Definition Classes: root

Definition Classes: root

Definition Classes: com

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 durablequeue

The com.cisco.streambed.durablequeue.DurableQueue is at the heart of streambed.

The com.cisco.streambed.durablequeue.DurableQueue is at the heart of streambed. Streambed programs are essentially formed around the durable queue. Use a com.cisco.streambed.durablequeue.DurableQueue.Provider to declare the type of queue you require. See the package doc for Streambed's ChronicleQueue for an example.

Definition Classes: streambed

package chroniclequeue

Provides an implementation of com.cisco.streambed.durablequeue.DurableQueue that uses ChronicleQueue.

Definition Classes: durablequeue

package namespaced

Definition Classes: durablequeue

package noop

Definition Classes: durablequeue

package opentelemetry

Utilities for using OpenTracing with durable queues.

Definition Classes: durablequeue

package remote

Definition Classes: durablequeue

DurableQueueServerEntryPoints

FlowConnectionParameters

TcpConnectionParameters

UnixDomainSocketConnectionParameters

com.cisco.streambed.durablequeue

remote

package remote

Ordering

Alphabetic

Visibility

Public
Protected

Type Members

class Client extends DurableQueue
Provides an implementation of DurableQueue that communicates with a server via MQTT.
Provides an implementation of DurableQueue that communicates with a server via MQTT.
Annotations
@SuppressWarnings()
sealed trait ConnectionParameters extends AnyRef
Holds relevant configuration for the types of connections that are supported by the client.
trait DurableQueueProvider extends Provider[Client]
DurableQueue.Provider implementation that uses a server to store data.
DurableQueue.Provider implementation that uses a server to store data. Mix this into your Application class to use the remote DQ server/client as your DurableQueue.
Annotations
@SuppressWarnings()
abstract class DurableQueueServer extends Application
Implements an MQTT-based server for the DurableQueue abstraction.
Implements an MQTT-based server for the DurableQueue abstraction. This allows clients to connect and share the same underlying DurableQueue over the network.
case class FlowConnectionParameters[A](flow: Flow[ByteString, ByteString, A]) extends ConnectionParameters with Product with Serializable
case class TcpConnectionParameters(host: String, port: Int, tls: Boolean) extends ConnectionParameters with Product with Serializable
case class UnixDomainSocketConnectionParameters(path: String) extends ConnectionParameters with Product with Serializable

Value Members

object Client
object DurableQueueServerEntryPoints
Entry point for the DurableQueueServer.

Packages

remote

package remote

Type Members

Value Members

Ungrouped

remote