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 lora
    Definition Classes
    streambed
  • package controlplane

    LoRaWAN device meta data event declarations so that devices can be made known to the system as a whole.

    LoRaWAN device meta data event declarations so that devices can be made known to the system as a whole.

    Definition Classes
    lora
  • package packet

    LoRaWAN packet codec and its associated domain model.

    LoRaWAN packet codec and its associated domain model. The main functions here are the com.cisco.streambed.lora.packet.PHYPayloadCodec encode/decode ones. For reference on the LoRaWAN types in general, please consult the LoRaWAN specifications.

    Definition Classes
    lora
  • package encoder
  • AppSKey
  • CFList
  • ConfirmedDataDown
  • ConfirmedDataUp
  • DLSettings
  • DevAddr
  • DevEUI
  • DevNonce
  • FCnt
  • FCtrl
  • FHDR
  • FOpts
  • FPort
  • FRMPayload
  • JoinAccept
  • JoinEUI
  • JoinNonce
  • JoinRequest
  • LinkCheckAns
  • LinkCheckReq
  • MACCommand
  • MACCommandCodec
  • MHDR
  • MIC
  • MacPayload
  • NetID
  • NwkKey
  • NwkSEncKey
  • NwkSIntKey
  • PHYPayload
  • PHYPayloadCodec
  • RxDelay
  • UnconfirmedDataDown
  • UnconfirmedDataUp
  • package streams

    Utilities for dealing with LoRaWAN data in the context of Akka streams.

    Utilities for dealing with LoRaWAN data in the context of Akka streams.

    Definition Classes
    lora

package packet

LoRaWAN packet codec and its associated domain model. The main functions here are the com.cisco.streambed.lora.packet.PHYPayloadCodec encode/decode ones. For reference on the LoRaWAN types in general, please consult the LoRaWAN specifications.

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

Package Members

  1. package encoder

Type Members

  1. final case class AppSKey(underlying: Array[Byte]) extends AnyVal with Product with Serializable
  2. final case class CFList(underlying: Seq[Int]) extends AnyVal with Product with Serializable
  3. final case class ConfirmedDataDown(fhdr: FHDR, fPort: Option[FPort], frmPayload: Option[FRMPayload]) extends MacPayload with Product with Serializable
  4. final case class ConfirmedDataUp(fhdr: FHDR, fPort: Option[FPort], frmPayload: Option[FRMPayload]) extends MacPayload with Product with Serializable
  5. final case class DLSettings(underlying: Byte) extends AnyVal with Product with Serializable
  6. final case class DevAddr(underlying: Int) extends AnyVal with Product with Serializable
  7. final case class DevEUI(underlying: Long) extends AnyVal with Product with Serializable
  8. final case class DevNonce(underlying: Int) extends AnyVal with Product with Serializable
  9. final case class FCnt(underlying: Int) extends AnyVal with Product with Serializable
  10. final case class FCtrl(underlying: Byte) extends AnyVal with Product with Serializable
  11. final case class FHDR(devAddr: DevAddr, fCtrl: FCtrl, fCnt: FCnt, fOpts: FOpts) extends Product with Serializable
  12. final case class FOpts(underlying: Array[Byte]) extends AnyVal with Product with Serializable
  13. final case class FPort(underlying: Byte) extends AnyVal with Product with Serializable
  14. final case class FRMPayload(underlying: Array[Byte]) extends AnyVal with Product with Serializable
  15. final case class JoinAccept(joinNonce: JoinNonce, homeNetID: NetID, devAddr: DevAddr, dlSettings: DLSettings, rxDelay: RxDelay, cfList: Option[CFList]) extends PHYPayload with Product with Serializable
  16. final case class JoinEUI(underlying: Long) extends AnyVal with Product with Serializable
  17. final case class JoinNonce(underlying: Int) extends AnyVal with Product with Serializable
  18. final case class JoinRequest(joinEUI: JoinEUI, devEUI: DevEUI, devNonce: DevNonce) extends PHYPayload with Product with Serializable
  19. final case class LinkCheckAns(margin: Int, gwCnt: Int) extends MACCommand with Product with Serializable
  20. sealed abstract class MACCommand extends AnyRef

    A MAC command is used either for NS to end-device command communication (typical) or end-device to NS communication (atypical).

  21. final case class MHDR(underlying: Byte) extends AnyVal with Product with Serializable
  22. final case class MIC(underlying: Int) extends AnyVal with Product with Serializable
  23. abstract class MacPayload extends PHYPayload
  24. final case class NetID(underlying: Int) extends AnyVal with Product with Serializable
  25. final case class NwkKey(underlying: Array[Byte]) extends AnyVal with Product with Serializable
  26. final case class NwkSEncKey(underlying: Array[Byte]) extends AnyVal with Product with Serializable
  27. final case class NwkSIntKey(underlying: Array[Byte]) extends AnyVal with Product with Serializable
  28. sealed abstract class PHYPayload extends AnyRef
  29. final case class RxDelay(underlying: Byte) extends AnyVal with Product with Serializable
  30. final case class UnconfirmedDataDown(fhdr: FHDR, fPort: Option[FPort], frmPayload: Option[FRMPayload]) extends MacPayload with Product with Serializable
  31. final case class UnconfirmedDataUp(fhdr: FHDR, fPort: Option[FPort], frmPayload: Option[FRMPayload]) extends MacPayload with Product with Serializable

Value Members

  1. object DLSettings extends Serializable
  2. object DevAddr extends Serializable
  3. object DevEUI extends Serializable
  4. object DevNonce extends Serializable
  5. object FCnt extends Serializable
  6. object FCtrl extends Serializable
  7. object FOpts extends Serializable
  8. object FPort extends Serializable
  9. object FRMPayload extends Serializable
  10. object JoinAccept extends Serializable
  11. object JoinEUI extends Serializable
  12. object JoinNonce extends Serializable
  13. object JoinRequest extends Serializable
  14. object LinkCheckAns extends Serializable
  15. case object LinkCheckReq extends MACCommand with Product with Serializable
  16. object MACCommand
  17. object MACCommandCodec

    Provides encoding/decoding to/from bytes from/to a LoRa MAC Command object

  18. object MHDR extends Serializable
  19. object MIC extends Serializable
  20. object NetID extends Serializable
  21. object PHYPayloadCodec

    Provides encoding/decoding to/from bytes from/to a LoRa domain object

  22. object RxDelay extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped