Object/Class

scodec.protocols.time

TimeStamped

Related Docs: class TimeStamped | package time

Permalink

object TimeStamped extends Serializable

Source
TimeStamped.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TimeStamped
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def attemptReorderLocally[F[_], A](over: FiniteDuration): Pipe[F, TimeStamped[A], TimeStamped[A]]

    Permalink

    Stream transducer that reorders timestamped values over a specified duration.

    Stream transducer that reorders timestamped values over a specified duration.

    Values are kept in an internal buffer. Upon receiving a new value, any buffered values that are timestamped with value.time - over are emitted. Other values, and the new value, are kept in the buffer.

    This is useful for ordering mostly ordered streams, where values may be out of order with close neighbors but are strictly less than values that come much later in the stream.

    An example of such a structure is the result of merging streams of values generated with TimeStamped.now.

    Caution: this transducer should only be used on streams that are mostly ordered. In the worst case, if the source is in reverse order, all values in the source will be accumulated in to the buffer until the source halts, and then the{ values will be emitted in order.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. def increasing[F[_], A]: Pipe[F, TimeStamped[A], TimeStamped[A]]

    Permalink

    Stream transducer that filters the specified timestamped values to ensure the output time stamps are always increasing in time.

    Stream transducer that filters the specified timestamped values to ensure the output time stamps are always increasing in time. Other values are dropped.

  13. def increasingW[F[_], A]: Pipe[F, TimeStamped[A], Either[TimeStamped[A], TimeStamped[A]]]

    Permalink

    Stream transducer that filters the specified timestamped values to ensure the output time stamps are always increasing in time.

    Stream transducer that filters the specified timestamped values to ensure the output time stamps are always increasing in time. The increasing values are emitted as output of the writer, while out of order values are written to the writer side of the writer.

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. def liftL[A, B, C](p: Pipe[Pure, TimeStamped[A], TimeStamped[B]]): Pipe[Pure, TimeStamped[Either[A, C]], TimeStamped[Either[B, C]]]

    Permalink
  16. def liftR[A, B, C](p: Pipe[Pure, TimeStamped[A], TimeStamped[B]]): Pipe[Pure, TimeStamped[Either[C, A]], TimeStamped[Either[C, B]]]

    Permalink
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. def now[A](a: A): TimeStamped[A]

    Permalink
  21. implicit def ordering[A](implicit A: Ordering[A]): Ordering[TimeStamped[A]]

    Permalink

    Orders values by timestamp, then by value.

  22. def perSecondRate[F[_], A, B](f: (A) ⇒ B)(zero: B, combine: (B, B) ⇒ B): Pipe[F, TimeStamped[A], TimeStamped[B]]

    Permalink

    Stream transducer that converts a stream of TimeStamped[A] in to a stream of TimeStamped[B] where B is an accumulated feature of A over a second.

    Stream transducer that converts a stream of TimeStamped[A] in to a stream of TimeStamped[B] where B is an accumulated feature of A over a second.

    For example, the emitted bits per second of a Stream[Task, ByteVector] can be calculated using perSecondRate(_.size * 8), which yields a stream of the emitted bits per second.

    f

    function which extracts a feature of A

  23. def preserveTimeStamps[A, B](p: Pipe[Pure, A, B]): Pipe[Pure, TimeStamped[A], TimeStamped[B]]

    Permalink

    Combinator that converts a Pipe[Pure, A, B] in to a Pipe[Pure, TimeStamped[A], TimeStamped[B]] such that timestamps are preserved on elements that flow through the stream.

  24. def rate[F[_], A, B](over: FiniteDuration)(f: (A) ⇒ B)(zero: B, combine: (B, B) ⇒ B): Pipe[F, TimeStamped[A], TimeStamped[B]]

    Permalink

    Stream transducer that converts a stream of TimeStamped[A] in to a stream of TimeStamped[B] where B is an accumulated feature of A over a specified time period.

    Stream transducer that converts a stream of TimeStamped[A] in to a stream of TimeStamped[B] where B is an accumulated feature of A over a specified time period.

    For example, the emitted bits per second of a Stream[Task, ByteVector] can be calculated using rate(1.0)(_.size * 8), which yields a stream of the emitted bits per second.

    over

    time period over which to calculate

    f

    function which extracts a feature of A

    zero

    identity for combine

    combine

    closed function on B which forms a monoid with zero

  25. def reorderLocally[F[_], A](over: FiniteDuration): Pipe[F, TimeStamped[A], TimeStamped[A]]

    Permalink

    Stream transducer that reorders a stream of timestamped values that are mostly ordered, using a time based buffer of the specified duration.

    Stream transducer that reorders a stream of timestamped values that are mostly ordered, using a time based buffer of the specified duration. See attemptReorderLocally for details.

    The resulting stream is guaranteed to always emit values in time increasing order. Values may be dropped from the source stream if they were not successfully reordered.

  26. def reorderLocallyW[F[_], A](over: FiniteDuration): Pipe[F, TimeStamped[A], Either[TimeStamped[A], TimeStamped[A]]]

    Permalink

    Stream transducer that reorders a stream of timestamped values that are mostly ordered, using a time based buffer of the specified duration.

    Stream transducer that reorders a stream of timestamped values that are mostly ordered, using a time based buffer of the specified duration. See attemptReorderLocally for details.

    The resulting stream is guaranteed to always emit output values in time increasing order. Any values that could not be reordered due to insufficient buffer space are emitted on the writer (left) side.

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def throttle[A](source: Stream[Task, TimeStamped[A]], throttlingFactor: Double)(implicit S: Strategy, scheduler: Scheduler): Stream[Task, TimeStamped[A]]

    Permalink

    Returns a stream that is the throttled version of the source stream.

    Returns a stream that is the throttled version of the source stream.

    Given two adjacent items from the source stream, a and b, where a is emitted first and b is emitted second, their time delta is b.time - a.time.

    This function creates a stream that emits values at wall clock times such that the time delta between any two adjacent values is proportional to their time delta in the source stream.

    The throttlingFactor is a scaling factor that determines how much source time a unit of wall clock time is worth. A value of 1.0 causes the output stream to emit values spaced in wall clock time equal to their time deltas. A value of 2.0 emits values at twice the speed of wall clock time.

    This is particularly useful when timestamped data can be read in bulk (e.g., from a capture file) but should be "played back" at real time speeds.

  29. def timeBasedOrdering[A]: Ordering[TimeStamped[A]]

    Permalink

    Orders values by timestamp -- values with the same timestamp are considered equal.

  30. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def withPerSecondRate[F[_], A, B](f: (A) ⇒ B)(zero: B, combine: (B, B) ⇒ B): Pipe[F, TimeStamped[A], TimeStamped[Either[B, A]]]

    Permalink

    Stream transducer that converts a stream of TimeStamped[A] in to a stream of TimeStamped[B Either A] where B is an accumulated feature of A over a second.

    Stream transducer that converts a stream of TimeStamped[A] in to a stream of TimeStamped[B Either A] where B is an accumulated feature of A over a second.

    Every incoming A is echoed to the output.

    For example, the emitted bits per second of a Stream[Task, ByteVector] can be calculated using perSecondRate(_.size * 8), which yields a stream of the emitted bits per second.

    f

    function which extracts a feature of A

    zero

    identity for combine

    combine

    closed function on B which forms a monoid with zero

  35. def withRate[F[_], A, B](over: FiniteDuration)(f: (A) ⇒ B)(zero: B, combine: (B, B) ⇒ B): Pipe[F, TimeStamped[A], TimeStamped[Either[B, A]]]

    Permalink

    Stream transducer that converts a stream of TimeStamped[A] in to a stream of TimeStamped[Either[B, A]] where B is an accumulated feature of A over a specified time period.

    Stream transducer that converts a stream of TimeStamped[A] in to a stream of TimeStamped[Either[B, A]] where B is an accumulated feature of A over a specified time period.

    Every incoming A is echoed to the output.

    For example, the emitted bits per second of a Stream[Task, ByteVector] can be calculated using rate(1.0)(_.size * 8), which yields a stream of the emitted bits per second.

    over

    time period over which to calculate

    f

    function which extracts a feature of A

    zero

    identity for combine

    combine

    closed function on B which forms a monoid with zero

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped