Packages

  • package root
    Definition Classes
    root
  • package csw
    Definition Classes
    root
  • package time
    Definition Classes
    csw
  • package scheduler

    This module provides implementation for Time Service Scheduler which provides APIs for scheduling periodic and non-periodic tasks in the future, which are optimised for scheduling at up to 1KHz frequency.

    This module provides implementation for Time Service Scheduler which provides APIs for scheduling periodic and non-periodic tasks in the future, which are optimised for scheduling at up to 1KHz frequency.

    For component developers, the scheduler API is injected in the ComponentHandlers. Hence for them, there is no need to create a csw.time.scheduler.api.TimeServiceScheduler instance.

    If you are not using csw-framework, you can create an instance like shown below.

    val scheduler: TimeServiceScheduler = TimeServiceSchedulerFactory.make()(actorSystem)

    In addition to the Scheduler API, this module also provides a csw.time.core.TMTTimeHelper API which provides additional time zone related functionality on top of csw.time.core.models.TMTTime. It allows users to get a java.time.ZonedDateTime representation of a TMTTime.

    Following is a small sample showing how to access utilities from TMTTimeHelper.

    TMTTimeHelper.atLocal(utcTime)
TMTTimeHelper.atHawaii(utcTime)
    Definition Classes
    time
  • package api
    Definition Classes
    scheduler
  • Cancellable
  • TimeServiceScheduler
t

csw.time.scheduler.api

Cancellable

trait Cancellable extends AnyRef

API for a scheduled periodic task, that allows it to be cancelled.

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

Abstract Value Members

  1. abstract def cancel(): Boolean

    Cancels this Cancellable and returns true if that was successful.

    Cancels this Cancellable and returns true if that was successful. If this cancellable was (concurrently) cancelled already, then this method will return false.

    returns

    whether or not the cancellable was cancelled successfully

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped