Packages

  • package root

    This is documentation for Mothra, a collection of Scala and Spark library functions for working with Internet-related data.

    This is documentation for Mothra, a collection of Scala and Spark library functions for working with Internet-related data. Some modules contain APIs of general use to Scala programmers. Some modules make those tools more useful on Spark data-processing systems.

    Please see the documentation for the individual packages for more details on their use.

    Scala Packages

    These packages are useful in Scala code without involving Spark:

    org.cert.netsa.data

    This package, which is collected as the netsa-data library, provides types for working with various kinds of information:

    org.cert.netsa.io.ipfix

    The netsa-io-ipfix library provides tools for reading and writing IETF IPFIX data from various connections and files.

    org.cert.netsa.io.silk

    To read and write CERT NetSA SiLK file formats and configuration files, use the netsa-io-silk library.

    org.cert.netsa.util

    The "junk drawer" of netsa-util so far provides only two features: First, a method for equipping Scala scala.collection.Iterators with exception handling. And second, a way to query the versions of NetSA libraries present in a JVM at runtime.

    Spark Packages

    These packages require the use of Apache Spark:

    org.cert.netsa.mothra.datasources

    Spark datasources for CERT file types. This package contains utility features which add methods to Apache Spark DataFrameReader objects, allowing IPFIX and SiLK flows to be opened using simple spark.read... calls.

    The mothra-datasources library contains both IPFIX and SiLK functionality, while mothra-datasources-ipfix and mothra-datasources-silk contain only what's needed for the named datasource.

    org.cert.netsa.mothra.analysis

    A grab-bag of analysis helper functions and example analyses.

    org.cert.netsa.mothra.functions

    This single Scala object provides Spark SQL functions for working with network data. It is the entirety of the mothra-functions library.

    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package cert
    Definition Classes
    org
  • package netsa
    Definition Classes
    cert
  • package data

    The org.cert.netsa.data.net package is for working with network-related data.

    The org.cert.netsa.data.net package is for working with network-related data. This includes types for IP addresses, port numbers, protocol numbers, and the like. Many of these types have namespaces managed by IANA, and the types provide mechanisms for looking up names from numbers and vice-versa based on embedded copies of IANA's tables.

    In org.cert.netsa.data.time you can find an Ordering for Java LocalDate objects, and a type LocalDateSet for working with sets of those dates.

    Finally, org.cert.netsa.data.unsigned contains types for working with unsigned integer values.

    Definition Classes
    netsa
  • package unsigned

    A variety of unsigned integral types, and new methods on the built-in integral types for working with them.

    A variety of unsigned integral types, and new methods on the built-in integral types for working with them.

    Import the implicit conversions from this package to add toUInt methods and the like to standard Scala types.

    Features

    The overall pattern for each integral type (UByte, UShort, UInt, ULong) is the following (using UByte as the example):

    Unsigned alues can be constructed from signed Byte and Int values using UByte(b: Byte) and UByte(i: Int).

    x.toUByte, x.toUShort, etc. and x.toByte, x.toShort, etc. methods are included.

    All of the expected comparison, arithmetic, and bitwise operations are present. In addition, UByte extends Comparable, and equipped with an Ordering and membership in the Integral type class.

    UByte.MinValue and UByte.MaxValue are defined.

    If you import implicits.ByteUnsignedConversions, then x.toUByte, etc. methods will be available by implicit conversion on Byte values.

    Definition Classes
    data
    Note

    If you are concerned with efficiency, do not create arrays of unsigned values, as the will be boxed into objects. Instead, create arrays of normal signed values and then convert to and from unsigned when getting and setting the values.

  • object UInt
    Definition Classes
    unsigned
  • UIntIsIntegral
  • UIntOrdering

trait UIntIsIntegral extends Integral[UInt]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UIntIsIntegral
  2. Integral
  3. Numeric
  4. Ordering
  5. PartialOrdering
  6. Equiv
  7. Serializable
  8. Comparator
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class IntegralOps extends scala.math.Integral.NumericOps
    Definition Classes
    Integral
  2. class NumericOps extends AnyRef
    Definition Classes
    Numeric
  3. class OrderingOps extends AnyRef
    Definition Classes
    Ordering

Abstract Value Members

  1. abstract def compare(x: UInt, y: UInt): Int
    Definition Classes
    Ordering → Comparator

Concrete 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. def abs(x: UInt): UInt
    Definition Classes
    Numeric
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def equiv(x: UInt, y: UInt): Boolean
    Definition Classes
    Ordering → PartialOrdering → Equiv
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. def fromInt(x: Int): UInt
    Definition Classes
    UIntIsIntegral → Numeric
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def gt(x: UInt, y: UInt): Boolean
    Definition Classes
    Ordering → PartialOrdering
  14. def gteq(x: UInt, y: UInt): Boolean
    Definition Classes
    Ordering → PartialOrdering
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def isReverseOf(other: Ordering[_]): Boolean
    Definition Classes
    Ordering
  18. def lt(x: UInt, y: UInt): Boolean
    Definition Classes
    Ordering → PartialOrdering
  19. def lteq(x: UInt, y: UInt): Boolean
    Definition Classes
    Ordering → PartialOrdering
  20. def max[U <: UInt](x: U, y: U): U
    Definition Classes
    Ordering
  21. def min[U <: UInt](x: U, y: U): U
    Definition Classes
    Ordering
  22. def minus(x: UInt, y: UInt): UInt
    Definition Classes
    UIntIsIntegral → Numeric
  23. implicit def mkNumericOps(lhs: UInt): IntegralOps
    Definition Classes
    Integral → Numeric
  24. implicit def mkOrderingOps(lhs: UInt): OrderingOps
    Definition Classes
    Ordering
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def negate(x: UInt): UInt
    Definition Classes
    UIntIsIntegral → Numeric
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def on[U](f: (U) => UInt): Ordering[U]
    Definition Classes
    Ordering
  30. def one: UInt
    Definition Classes
    Numeric
  31. def orElse(other: Ordering[UInt]): Ordering[UInt]
    Definition Classes
    Ordering
  32. def orElseBy[S](f: (UInt) => S)(implicit ord: Ordering[S]): Ordering[UInt]
    Definition Classes
    Ordering
  33. def parseString(str: String): Option[UInt]
    Definition Classes
    UIntIsIntegral → Numeric
  34. def plus(x: UInt, y: UInt): UInt
    Definition Classes
    UIntIsIntegral → Numeric
  35. def quot(x: UInt, y: UInt): UInt
    Definition Classes
    UIntIsIntegral → Integral
  36. def rem(x: UInt, y: UInt): UInt
    Definition Classes
    UIntIsIntegral → Integral
  37. def reverse: Ordering[UInt]
    Definition Classes
    Ordering → PartialOrdering
  38. def reversed(): Comparator[UInt]
    Definition Classes
    Comparator
  39. def sign(x: UInt): UInt
    Definition Classes
    Numeric
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def thenComparing[U <: Comparable[_ >: U <: AnyRef]](arg0: Function[_ >: UInt <: AnyRef, _ <: U]): Comparator[UInt]
    Definition Classes
    Comparator
  42. def thenComparing[U <: AnyRef](arg0: Function[_ >: UInt <: AnyRef, _ <: U], arg1: Comparator[_ >: U <: AnyRef]): Comparator[UInt]
    Definition Classes
    Comparator
  43. def thenComparing(arg0: Comparator[_ >: UInt <: AnyRef]): Comparator[UInt]
    Definition Classes
    Comparator
  44. def thenComparingDouble(arg0: ToDoubleFunction[_ >: UInt <: AnyRef]): Comparator[UInt]
    Definition Classes
    Comparator
  45. def thenComparingInt(arg0: ToIntFunction[_ >: UInt <: AnyRef]): Comparator[UInt]
    Definition Classes
    Comparator
  46. def thenComparingLong(arg0: ToLongFunction[_ >: UInt <: AnyRef]): Comparator[UInt]
    Definition Classes
    Comparator
  47. def times(x: UInt, y: UInt): UInt
    Definition Classes
    UIntIsIntegral → Numeric
  48. def toDouble(x: UInt): Double
    Definition Classes
    UIntIsIntegral → Numeric
  49. def toFloat(x: UInt): Float
    Definition Classes
    UIntIsIntegral → Numeric
  50. def toInt(x: UInt): Int
    Definition Classes
    UIntIsIntegral → Numeric
  51. def toLong(x: UInt): Long
    Definition Classes
    UIntIsIntegral → Numeric
  52. def toString(): String
    Definition Classes
    AnyRef → Any
  53. def tryCompare(x: UInt, y: UInt): Some[Int]
    Definition Classes
    Ordering → PartialOrdering
  54. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  57. def zero: UInt
    Definition Classes
    Numeric

Deprecated Value Members

  1. def signum(x: UInt): Int
    Definition Classes
    Numeric
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) use sign method instead

Inherited from Integral[UInt]

Inherited from Numeric[UInt]

Inherited from Ordering[UInt]

Inherited from PartialOrdering[UInt]

Inherited from Equiv[UInt]

Inherited from Serializable

Inherited from Comparator[UInt]

Inherited from AnyRef

Inherited from Any

Ungrouped