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.

  • UByte
  • UInt
  • ULong
  • UShort
  • implicits

final class UByte extends AnyVal with Comparable[UByte] with ScalaNumericAnyConversions

An unsigned 8-bit value, also known as an octet, unsigned byte, or uint8.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UByte
  2. ScalaNumericAnyConversions
  3. Comparable
  4. AnyVal
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new UByte(signed: Byte)

    signed

    Signed view of this value.

Value Members

  1. def !=(o: UByte): Boolean
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  3. final def ##: Int
    Definition Classes
    Any
  4. def %(o: UByte): UByte
  5. def &(o: ULong): ULong
  6. def &(o: UInt): UInt
  7. def &(o: UShort): UShort
  8. def &(o: UByte): UByte
  9. def *(o: UByte): UByte
  10. def +(o: UByte): UByte
  11. def -(o: UByte): UByte
  12. def /(o: UByte): UByte
  13. def <(o: UByte): Boolean
  14. def <<(s: Long): UByte
  15. def <<(s: Int): UByte
  16. def <=(o: UByte): Boolean
  17. def ==(o: UByte): Boolean
  18. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  19. def >(o: UByte): Boolean
  20. def >=(o: UByte): Boolean
  21. def >>(s: Long): UByte
  22. def >>(s: Int): UByte
  23. def >>>(s: Long): UByte
  24. def >>>(s: Int): UByte
  25. def ^(o: ULong): ULong
  26. def ^(o: UInt): UInt
  27. def ^(o: UShort): UShort
  28. def ^(o: UByte): UByte
  29. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  30. def byteValue: Byte
    Definition Classes
    UByte → ScalaNumericAnyConversions
  31. def compareTo(o: UByte): Int
    Definition Classes
    UByte → Comparable
  32. def doubleValue: Double
    Definition Classes
    UByte → ScalaNumericAnyConversions
  33. def floatValue: Float
    Definition Classes
    UByte → ScalaNumericAnyConversions
  34. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  35. def intValue: Int
    Definition Classes
    UByte → ScalaNumericAnyConversions
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. def isValidByte: Boolean
    Definition Classes
    UByte → ScalaNumericAnyConversions
  38. def isValidChar: Boolean
    Definition Classes
    UByte → ScalaNumericAnyConversions
  39. def isValidInt: Boolean
    Definition Classes
    UByte → ScalaNumericAnyConversions
  40. def isValidShort: Boolean
    Definition Classes
    UByte → ScalaNumericAnyConversions
  41. def isWhole: Boolean
    Definition Classes
    UByte → ScalaNumericAnyConversions
  42. def longValue: Long
    Definition Classes
    UByte → ScalaNumericAnyConversions
  43. def shortValue: Short
    Definition Classes
    UByte → ScalaNumericAnyConversions
  44. val signed: Byte
  45. def toByte: Byte
    Definition Classes
    UByte → ScalaNumericAnyConversions
  46. def toChar: Char
    Definition Classes
    UByte → ScalaNumericAnyConversions
  47. def toDouble: Double
    Definition Classes
    UByte → ScalaNumericAnyConversions
  48. def toFloat: Float
    Definition Classes
    UByte → ScalaNumericAnyConversions
  49. def toHexString: String
  50. def toInt: Int
    Definition Classes
    UByte → ScalaNumericAnyConversions
  51. def toLong: Long
    Definition Classes
    UByte → ScalaNumericAnyConversions
  52. def toShort: Short
    Definition Classes
    UByte → ScalaNumericAnyConversions
  53. def toString(): String
    Definition Classes
    UByte → Any
  54. def toUByte: UByte
  55. def toUInt: UInt
  56. def toULong: ULong
  57. def toUShort: UShort
  58. def unary_+: UByte
  59. def unary_-: UByte
  60. def unary_~: UByte
  61. def underlying: Any
  62. def unifiedPrimitiveEquals(x: Any): Boolean
    Attributes
    protected
    Definition Classes
    ScalaNumericAnyConversions
  63. def unifiedPrimitiveHashcode: Int
    Attributes
    protected
    Definition Classes
    ScalaNumericAnyConversions
  64. def unsigned: UByte

    Unsigned view of this value.

  65. def |(o: ULong): ULong
  66. def |(o: UInt): UInt
  67. def |(o: UShort): UShort
  68. def |(o: UByte): UByte

Inherited from Comparable[UByte]

Inherited from AnyVal

Inherited from Any

Ungrouped