colossus.core

WorkerRef

case class WorkerRef(id: Int, metrics: LocalCollection, worker: ActorRef, system: IOSystem) extends Product with Serializable

This is a Worker's public interface. This is what can be used to communicate with a Worker, as it wraps the Worker's ActorRef, as well as providing some additional information which can be made public.

id

The Worker's id.

metrics

The Metrics associated with this Worker

worker

The ActorRef of the Worker

system

The IOSystem to which this Worker belongs

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WorkerRef
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WorkerRef(id: Int, metrics: LocalCollection, worker: ActorRef, system: IOSystem)

    id

    The Worker's id.

    metrics

    The Metrics associated with this Worker

    worker

    The ActorRef of the Worker

    system

    The IOSystem to which this Worker belongs

Value Members

  1. def !(message: Any)(implicit sender: ActorRef = ActorRef.noSender): Unit

    Send this Worker a message

    Send this Worker a message

    message

    The message to send

    sender

    The sendef of the message

    returns

  2. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  4. final def ##(): Int

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

    Definition Classes
    AnyRef
  6. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def bind(item: WorkerItem): Unit

    Bind a new worker item to this worker.

    Bind a new worker item to this worker. The item should have been created and initialized within this worker to ensure that the worker item's lifecycle is single-threaded.

  9. implicit val callbackExecutor: CallbackExecutor

    The representation of this worker as a [CallbackExecutor].

    The representation of this worker as a [CallbackExecutor]. Bring this into scope to easily convert Futures into Callbacks. This uses the default dispatcher of the worker's underlying ActorSystem.

  10. def clone(): AnyRef

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

    Definition Classes
    AnyRef
  12. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  14. val id: Int

    The Worker's id.

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. val metrics: LocalCollection

    The Metrics associated with this Worker

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

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

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

    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  21. val system: IOSystem

    The IOSystem to which this Worker belongs

  22. def unbind(workerItemId: Long): Unit

  23. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. val worker: ActorRef

    The ActorRef of the Worker

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped