c

akka.testkit

CallingThreadMailbox

class CallingThreadMailbox extends Mailbox with DefaultSystemMessageQueue

Source
CallingThreadDispatcher.scala
Linear Supertypes
DefaultSystemMessageQueue, Mailbox, Runnable, SystemMessageQueue, ForkJoinTask[Unit], Serializable, Future[Unit], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CallingThreadMailbox
  2. DefaultSystemMessageQueue
  3. Mailbox
  4. Runnable
  5. SystemMessageQueue
  6. ForkJoinTask
  7. Serializable
  8. Future
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CallingThreadMailbox(_receiver: Cell, mailboxType: MailboxType)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from CallingThreadMailbox to any2stringadd[CallingThreadMailbox] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CallingThreadMailbox, B)
    Implicit
    This member is added by an implicit conversion from CallingThreadMailbox to ArrowAssoc[CallingThreadMailbox] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. var _statusDoNotCallMeDirectly: Status
    Attributes
    protected
    Definition Classes
    Mailbox
  7. var _systemQueueDoNotCallMeDirectly: SystemMessage
    Attributes
    protected
    Definition Classes
    Mailbox
  8. var actor: ActorCell
    Definition Classes
    Mailbox
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. final def becomeClosed(): Boolean

    set new primary status Closed.

    set new primary status Closed. Caller does not need to worry about whether status was Scheduled or not.

    Definition Classes
    Mailbox
    Annotations
    @tailrec()
  11. final def canBeScheduledForExecution(hasMessageHint: Boolean, hasSystemMessageHint: Boolean): Boolean
    Definition Classes
    Mailbox
  12. def cancel(mayInterruptIfRunning: Boolean): Boolean

    Attempts to cancel execution of this task.

    Attempts to cancel execution of this task. This attempt will fail if the task has already completed or could not be cancelled for some other reason. If successful, and this task has not started when cancel is called, execution of this task is suppressed. After this method returns successfully, unless there is an intervening call to #reinitialize, subsequent calls to #isCancelled, #isDone, and cancel will return true and calls to #join and related methods will result in CancellationException.

    This method may be overridden in subclasses, but if so, must still ensure that these properties hold. In particular, the cancel method itself must not throw exceptions.

    This method is designed to be invoked by other tasks. To terminate the current task, you can just return or throw an unchecked exception from its computation method, or invoke #completeExceptionally.

    mayInterruptIfRunning

    this value has no effect in the default implementation because interrupts are not used to control cancellation.

    returns

    true if this task is now cancelled

    Definition Classes
    ForkJoinTask → Future
  13. def cleanUp(): Unit

    Overridable callback to clean up the mailbox, called when an actor is unregistered.

    Overridable callback to clean up the mailbox, called when an actor is unregistered. By default it dequeues all system messages + messages and ships them to the owning actors' systems' DeadLetterMailbox

    Definition Classes
    CallingThreadMailbox → Mailbox
  14. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  15. final def compareAndSetForkJoinTaskTag(e: Short, tag: Short): Boolean

    Atomically conditionally sets the tag value for this task.

    Atomically conditionally sets the tag value for this task. Among other applications, tags can be used as visit markers in tasks operating on graphs, as in methods that check: if (task.compareAndSetForkJoinTaskTag((short)0, (short)1)) before processing, otherwise exiting because the node has already been visited.

    e

    the expected tag value

    tag

    the new tag value

    returns

    true if successful; i.e., the current value was equal to e and is now tag.

    Definition Classes
    ForkJoinTask
    Since

    1.8

  16. def complete(value: Unit): Unit

    Completes this task, and if not already aborted or cancelled, returning the given value as the result of subsequent invocations of join and related operations.

    Completes this task, and if not already aborted or cancelled, returning the given value as the result of subsequent invocations of join and related operations. This method may be used to provide results for asynchronous tasks, or to provide alternative handling for tasks that would not otherwise complete normally. Its use in other situations is discouraged. This method is overridable, but overridden versions must invoke super implementation to maintain guarantees.

    value

    the result value for this task

    Definition Classes
    ForkJoinTask
  17. def completeExceptionally(ex: Throwable): Unit

    Completes this task abnormally, and if not already aborted or cancelled, causes it to throw the given exception upon join and related operations.

    Completes this task abnormally, and if not already aborted or cancelled, causes it to throw the given exception upon join and related operations. This method may be used to induce exceptions in asynchronous tasks, or to force completion of tasks that would not otherwise complete. Its use in other situations is discouraged. This method is overridable, but overridden versions must invoke super implementation to maintain guarantees.

    ex

    the exception to throw. If this exception is not a RuntimeException or Error, the actual exception thrown will be a RuntimeException with cause ex.

    Definition Classes
    ForkJoinTask
  18. val ctdLock: ReentrantLock
  19. final def currentStatus: Status
    Definition Classes
    Mailbox
    Annotations
    @inline()
  20. def dequeue(): Envelope

    Try to dequeue the next message from this queue, return null failing that.

    Try to dequeue the next message from this queue, return null failing that.

    Definition Classes
    CallingThreadMailbox → Mailbox
  21. def dispatcher: MessageDispatcher
    Definition Classes
    Mailbox
  22. def enqueue(receiver: ActorRef, msg: Envelope): Unit

    Try to enqueue the message to this queue, or throw an exception.

    Try to enqueue the message to this queue, or throw an exception.

    Definition Classes
    CallingThreadMailbox → Mailbox
  23. def ensuring(cond: (CallingThreadMailbox) ⇒ Boolean, msg: ⇒ Any): CallingThreadMailbox
    Implicit
    This member is added by an implicit conversion from CallingThreadMailbox to Ensuring[CallingThreadMailbox] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: (CallingThreadMailbox) ⇒ Boolean): CallingThreadMailbox
    Implicit
    This member is added by an implicit conversion from CallingThreadMailbox to Ensuring[CallingThreadMailbox] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean, msg: ⇒ Any): CallingThreadMailbox
    Implicit
    This member is added by an implicit conversion from CallingThreadMailbox to Ensuring[CallingThreadMailbox] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: Boolean): CallingThreadMailbox
    Implicit
    This member is added by an implicit conversion from CallingThreadMailbox to Ensuring[CallingThreadMailbox] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  29. final def exec(): Boolean

    Immediately performs the base action of this task and returns true if, upon return from this method, this task is guaranteed to have completed normally.

    Immediately performs the base action of this task and returns true if, upon return from this method, this task is guaranteed to have completed normally. This method may return false otherwise, to indicate that this task is not necessarily complete (or is not known to be complete), for example in asynchronous actions that require explicit invocations of completion methods. This method may also throw an (unchecked) exception to indicate abnormal exit. This method is designed to support extensions, and should not in general be called otherwise.

    returns

    true if this task is known to have completed normally

    Definition Classes
    Mailbox → ForkJoinTask
  30. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. final def fork(): ForkJoinTask[Unit]

    Arranges to asynchronously execute this task in the pool the current task is running in, if applicable, or using the ForkJoinPool#commonPool() if not #inForkJoinPool.

    Arranges to asynchronously execute this task in the pool the current task is running in, if applicable, or using the ForkJoinPool#commonPool() if not #inForkJoinPool. While it is not necessarily enforced, it is a usage error to fork a task more than once unless it has completed and been reinitialized. Subsequent modifications to the state of this task or any data it operates on are not necessarily consistently observable by any thread other than the one executing it unless preceded by a call to #join or related methods, or a call to #isDone returning true.

    returns

    this, to simplify usage

    Definition Classes
    ForkJoinTask
  32. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from CallingThreadMailbox to StringFormat[CallingThreadMailbox] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  33. final def get(timeout: Long, unit: TimeUnit): Unit

    Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

    Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

    timeout

    the maximum time to wait

    unit

    the time unit of the timeout argument

    returns

    the computed result

    Definition Classes
    ForkJoinTask → Future
    Exceptions thrown

    CancellationException if the computation was cancelled

    ExecutionException if the computation threw an exception

    InterruptedException if the current thread is not a member of a ForkJoinPool and was interrupted while waiting

    TimeoutException if the wait timed out

  34. final def get(): Unit

    Waits if necessary for the computation to complete, and then retrieves its result.

    Waits if necessary for the computation to complete, and then retrieves its result.

    returns

    the computed result

    Definition Classes
    ForkJoinTask → Future
    Exceptions thrown

    CancellationException if the computation was cancelled

    ExecutionException if the computation threw an exception

    InterruptedException if the current thread is not a member of a ForkJoinPool and was interrupted while waiting

  35. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. final def getException(): Throwable

    Returns the exception thrown by the base computation, or a CancellationException if cancelled, or null if none or if the method has not yet completed.

    Returns the exception thrown by the base computation, or a CancellationException if cancelled, or null if none or if the method has not yet completed.

    returns

    the exception, or null if none

    Definition Classes
    ForkJoinTask
  37. final def getForkJoinTaskTag(): Short

    Returns the tag for this task.

    Returns the tag for this task.

    returns

    the tag for this task

    Definition Classes
    ForkJoinTask
    Since

    1.8

  38. final def getRawResult(): Unit

    Returns the result that would be returned by #join, even if this task completed abnormally, or null if this task is not known to have been completed.

    Returns the result that would be returned by #join, even if this task completed abnormally, or null if this task is not known to have been completed. This method is designed to aid debugging, as well as to support extensions. Its use in any other context is discouraged.

    returns

    the result, or null if not completed

    Definition Classes
    Mailbox → ForkJoinTask
  39. def hasMessages: Boolean

    Indicates whether this queue is non-empty.

    Indicates whether this queue is non-empty.

    Definition Classes
    CallingThreadMailbox → Mailbox
  40. def hasSystemMessages: Boolean
    Definition Classes
    DefaultSystemMessageQueue
  41. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  42. final def invoke(): Unit

    Commences performing this task, awaits its completion if necessary, and returns its result, or throws an (unchecked) RuntimeException or Error if the underlying computation did so.

    Commences performing this task, awaits its completion if necessary, and returns its result, or throws an (unchecked) RuntimeException or Error if the underlying computation did so.

    returns

    the computed result

    Definition Classes
    ForkJoinTask
  43. final def isCancelled(): Boolean
    Definition Classes
    ForkJoinTask → Future
  44. final def isClosed: Boolean
    Definition Classes
    Mailbox
    Annotations
    @inline()
  45. final def isCompletedAbnormally(): Boolean

    Returns true if this task threw an exception or was cancelled.

    Returns true if this task threw an exception or was cancelled.

    returns

    true if this task threw an exception or was cancelled

    Definition Classes
    ForkJoinTask
  46. final def isCompletedNormally(): Boolean

    Returns true if this task completed without throwing an exception and was not cancelled.

    Returns true if this task completed without throwing an exception and was not cancelled.

    returns

    true if this task completed without throwing an exception and was not cancelled

    Definition Classes
    ForkJoinTask
  47. final def isDone(): Boolean
    Definition Classes
    ForkJoinTask → Future
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. final def isScheduled: Boolean
    Definition Classes
    Mailbox
    Annotations
    @inline()
  50. final def isSuspended: Boolean
    Definition Classes
    Mailbox
    Annotations
    @inline()
  51. final def join(): Unit

    Returns the result of the computation when it is done.

    Returns the result of the computation when it is done. This method differs from #get() in that abnormal completion results in RuntimeException or Error, not ExecutionException, and that interrupts of the calling thread do not cause the method to abruptly return by throwing InterruptedException.

    returns

    the computed result

    Definition Classes
    ForkJoinTask
  52. val mailboxType: MailboxType
  53. val messageQueue: MessageQueue

    This is only a marker to be put in the messageQueue’s stead to make error messages pertaining to violated mailbox type requirements less cryptic.

    This is only a marker to be put in the messageQueue’s stead to make error messages pertaining to violated mailbox type requirements less cryptic.

    Definition Classes
    CallingThreadMailbox → Mailbox
  54. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  55. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  56. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  57. def numberOfMessages: Int

    Should return the current number of messages held in this queue; may always return 0 if no other value is available efficiently.

    Should return the current number of messages held in this queue; may always return 0 if no other value is available efficiently. Do not use this for testing for presence of messages, use hasMessages instead.

    Definition Classes
    CallingThreadMailbox → Mailbox
  58. final def processAllSystemMessages(): Unit

    Will at least try to process all queued system messages: in case of failure simply drop and go on to the next, because there is nothing to restart here (failure is in ActorCell somewhere …).

    Will at least try to process all queued system messages: in case of failure simply drop and go on to the next, because there is nothing to restart here (failure is in ActorCell somewhere …). In case the mailbox becomes closed (because of processing a Terminate message), dump all already dequeued message to deadLetters.

    Definition Classes
    Mailbox
  59. def queue: MessageQueue
  60. final def quietlyComplete(): Unit

    Completes this task normally without setting a value.

    Completes this task normally without setting a value. The most recent value established by #setRawResult (or null by default) will be returned as the result of subsequent invocations of join and related operations.

    Definition Classes
    ForkJoinTask
    Since

    1.8

  61. final def quietlyInvoke(): Unit

    Commences performing this task and awaits its completion if necessary, without returning its result or throwing its exception.

    Commences performing this task and awaits its completion if necessary, without returning its result or throwing its exception.

    Definition Classes
    ForkJoinTask
  62. final def quietlyJoin(): Unit

    Joins this task, without returning its result or throwing its exception.

    Joins this task, without returning its result or throwing its exception. This method may be useful when processing collections of tasks when some have been cancelled or otherwise known to have aborted.

    Definition Classes
    ForkJoinTask
  63. def reinitialize(): Unit

    Resets the internal bookkeeping state of this task, allowing a subsequent fork.

    Resets the internal bookkeeping state of this task, allowing a subsequent fork. This method allows repeated reuse of this task, but only if reuse occurs when this task has either never been forked, or has been forked, then completed and all outstanding joins of this task have also completed. Effects under any other usage conditions are not guaranteed. This method may be useful when executing pre-constructed trees of subtasks in loops.

    Upon completion of this method, isDone() reports false, and getException() reports null. However, the value returned by getRawResult is unaffected. To clear this value, you can invoke setRawResult(null).

    Definition Classes
    ForkJoinTask
  64. final def resume(): Boolean

    Reduce the suspend count by one.

    Reduce the suspend count by one. Caller does not need to worry about whether status was Scheduled or not.

    returns

    true if the suspend count reached zero

    Definition Classes
    Mailbox
    Annotations
    @tailrec()
  65. final def run(): Unit
    Definition Classes
    Mailbox → Runnable
  66. val self: ActorRef
  67. def setActor(cell: ActorCell): Unit
    Definition Classes
    Mailbox
  68. final def setAsIdle(): Boolean

    Reset Scheduled status, keeping primary status as is.

    Reset Scheduled status, keeping primary status as is.

    Definition Classes
    Mailbox
    Annotations
    @tailrec()
  69. final def setAsScheduled(): Boolean

    Set Scheduled status, keeping primary status as is.

    Set Scheduled status, keeping primary status as is.

    Definition Classes
    Mailbox
    Annotations
    @tailrec()
  70. final def setForkJoinTaskTag(tag: Short): Short

    Atomically sets the tag value for this task.

    Atomically sets the tag value for this task.

    tag

    the tag value

    returns

    the previous value of the tag

    Definition Classes
    ForkJoinTask
    Since

    1.8

  71. final def setRawResult(unit: Unit): Unit

    Forces the given value to be returned as a result.

    Forces the given value to be returned as a result. This method is designed to support extensions, and should not in general be called otherwise.

    Definition Classes
    Mailbox → ForkJoinTask
  72. final def setStatus(newStatus: Status): Unit
    Attributes
    protected
    Definition Classes
    Mailbox
    Annotations
    @inline()
  73. final def shouldProcessMessage: Boolean
    Definition Classes
    Mailbox
    Annotations
    @inline()
  74. final def suspend(): Boolean

    Increment the suspend count by one.

    Increment the suspend count by one. Caller does not need to worry about whether status was Scheduled or not.

    returns

    true if the previous suspend count was zero

    Definition Classes
    Mailbox
    Annotations
    @tailrec()
  75. final def suspendCount: Int
    Definition Classes
    Mailbox
    Annotations
    @inline()
  76. val suspendSwitch: Switch
  77. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  78. val system: ActorSystem
  79. final def systemDrain(newContents: LatestFirstSystemMessageList): EarliestFirstSystemMessageList
    Definition Classes
    DefaultSystemMessageQueue
    Annotations
    @tailrec()
  80. final def systemEnqueue(receiver: ActorRef, message: SystemMessage): Unit
    Definition Classes
    DefaultSystemMessageQueue
    Annotations
    @tailrec()
  81. final def systemQueueGet: LatestFirstSystemMessageList
    Attributes
    protected
    Definition Classes
    Mailbox
  82. final def systemQueuePut(_old: LatestFirstSystemMessageList, _new: LatestFirstSystemMessageList): Boolean
    Attributes
    protected
    Definition Classes
    Mailbox
  83. def toString(): String
    Definition Classes
    AnyRef → Any
  84. def tryUnfork(): Boolean

    Tries to unschedule this task for execution.

    Tries to unschedule this task for execution. This method will typically (but is not guaranteed to) succeed if this task is the most recently forked task by the current thread, and has not commenced executing in another thread. This method may be useful when arranging alternative local processing of tasks that could have been, but were not, stolen.

    returns

    true if unforked

    Definition Classes
    ForkJoinTask
  85. final def updateStatus(oldStatus: Status, newStatus: Status): Boolean
    Attributes
    protected
    Definition Classes
    Mailbox
    Annotations
    @inline()
  86. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  87. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  88. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  89. def [B](y: B): (CallingThreadMailbox, B)
    Implicit
    This member is added by an implicit conversion from CallingThreadMailbox to ArrowAssoc[CallingThreadMailbox] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from DefaultSystemMessageQueue

Inherited from Mailbox

Inherited from Runnable

Inherited from SystemMessageQueue

Inherited from ForkJoinTask[Unit]

Inherited from Serializable

Inherited from Future[Unit]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CallingThreadMailbox to any2stringadd[CallingThreadMailbox]

Inherited by implicit conversion StringFormat from CallingThreadMailbox to StringFormat[CallingThreadMailbox]

Inherited by implicit conversion Ensuring from CallingThreadMailbox to Ensuring[CallingThreadMailbox]

Inherited by implicit conversion ArrowAssoc from CallingThreadMailbox to ArrowAssoc[CallingThreadMailbox]

Ungrouped