class CallingThreadMailbox extends Mailbox with DefaultSystemMessageQueue
- Alphabetic
- By Inheritance
- CallingThreadMailbox
- DefaultSystemMessageQueue
- Mailbox
- Runnable
- SystemMessageQueue
- ForkJoinTask
- Serializable
- Future
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new CallingThreadMailbox(_receiver: Cell, mailboxType: MailboxType)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
var
_statusDoNotCallMeDirectly: Status
- Attributes
- protected
- Definition Classes
- Mailbox
-
var
_systemQueueDoNotCallMeDirectly: SystemMessage
- Attributes
- protected
- Definition Classes
- Mailbox
-
var
actor: ActorCell
- Definition Classes
- Mailbox
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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()
-
final
def
canBeScheduledForExecution(hasMessageHint: Boolean, hasSystemMessageHint: Boolean): Boolean
- Definition Classes
- Mailbox
-
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
, andcancel
will returntrue
and calls to#join
and related methods will result inCancellationException
.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
-
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
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
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
-
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 invokesuper
implementation to maintain guarantees.- value
the result value for this task
- Definition Classes
- ForkJoinTask
-
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 invokesuper
implementation to maintain guarantees.- ex
the exception to throw. If this exception is not a
RuntimeException
orError
, the actual exception thrown will be aRuntimeException
with causeex
.
- Definition Classes
- ForkJoinTask
- val ctdLock: ReentrantLock
-
final
def
currentStatus: Status
- Definition Classes
- Mailbox
- Annotations
- @inline()
-
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
-
def
dispatcher: MessageDispatcher
- Definition Classes
- Mailbox
-
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
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
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
returningtrue
.- returns
this
, to simplify usage
- Definition Classes
- ForkJoinTask
-
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()
-
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 cancelledExecutionException
if the computation threw an exceptionInterruptedException
if the current thread is not a member of a ForkJoinPool and was interrupted while waitingTimeoutException
if the wait timed out
-
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 cancelledExecutionException
if the computation threw an exceptionInterruptedException
if the current thread is not a member of a ForkJoinPool and was interrupted while waiting
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
getException(): Throwable
Returns the exception thrown by the base computation, or a
CancellationException
if cancelled, ornull
if none or if the method has not yet completed.Returns the exception thrown by the base computation, or a
CancellationException
if cancelled, ornull
if none or if the method has not yet completed.- returns
the exception, or
null
if none
- Definition Classes
- ForkJoinTask
-
final
def
getForkJoinTaskTag(): Short
Returns the tag for this task.
-
final
def
getRawResult(): Unit
Returns the result that would be returned by
#join
, even if this task completed abnormally, ornull
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, ornull
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
-
def
hasMessages: Boolean
Indicates whether this queue is non-empty.
Indicates whether this queue is non-empty.
- Definition Classes
- CallingThreadMailbox → Mailbox
-
def
hasSystemMessages: Boolean
- Definition Classes
- DefaultSystemMessageQueue
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
invoke(): Unit
Commences performing this task, awaits its completion if necessary, and returns its result, or throws an (unchecked)
RuntimeException
orError
if the underlying computation did so.Commences performing this task, awaits its completion if necessary, and returns its result, or throws an (unchecked)
RuntimeException
orError
if the underlying computation did so.- returns
the computed result
- Definition Classes
- ForkJoinTask
-
final
def
isCancelled(): Boolean
- Definition Classes
- ForkJoinTask → Future
-
final
def
isClosed: Boolean
- Definition Classes
- Mailbox
- Annotations
- @inline()
-
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
-
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
-
final
def
isDone(): Boolean
- Definition Classes
- ForkJoinTask → Future
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
isScheduled: Boolean
- Definition Classes
- Mailbox
- Annotations
- @inline()
-
final
def
isSuspended: Boolean
- Definition Classes
- Mailbox
- Annotations
- @inline()
-
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 inRuntimeException
orError
, notExecutionException
, and that interrupts of the calling thread do not cause the method to abruptly return by throwingInterruptedException
.- returns
the computed result
- Definition Classes
- ForkJoinTask
- val mailboxType: MailboxType
-
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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
-
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
- def queue: MessageQueue
-
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
(ornull
by default) will be returned as the result of subsequent invocations ofjoin
and related operations.- Definition Classes
- ForkJoinTask
- Since
1.8
-
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
-
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
-
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()
reportsfalse
, andgetException()
reportsnull
. However, the value returned bygetRawResult
is unaffected. To clear this value, you can invokesetRawResult(null)
.- Definition Classes
- ForkJoinTask
-
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()
-
final
def
run(): Unit
- Definition Classes
- Mailbox → Runnable
- val self: ActorRef
-
def
setActor(cell: ActorCell): Unit
- Definition Classes
- Mailbox
-
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()
-
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()
-
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
-
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
-
final
def
setStatus(newStatus: Status): Unit
- Attributes
- protected
- Definition Classes
- Mailbox
- Annotations
- @inline()
-
final
def
shouldProcessMessage: Boolean
- Definition Classes
- Mailbox
- Annotations
- @inline()
-
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()
-
final
def
suspendCount: Int
- Definition Classes
- Mailbox
- Annotations
- @inline()
- val suspendSwitch: Switch
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val system: ActorSystem
-
final
def
systemDrain(newContents: LatestFirstSystemMessageList): EarliestFirstSystemMessageList
- Definition Classes
- DefaultSystemMessageQueue
- Annotations
- @tailrec()
-
final
def
systemEnqueue(receiver: ActorRef, message: SystemMessage): Unit
- Definition Classes
- DefaultSystemMessageQueue
- Annotations
- @tailrec()
-
final
def
systemQueueGet: LatestFirstSystemMessageList
- Attributes
- protected
- Definition Classes
- Mailbox
-
final
def
systemQueuePut(_old: LatestFirstSystemMessageList, _new: LatestFirstSystemMessageList): Boolean
- Attributes
- protected
- Definition Classes
- Mailbox
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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
-
final
def
updateStatus(oldStatus: Status, newStatus: Status): Boolean
- Attributes
- protected
- Definition Classes
- Mailbox
- Annotations
- @inline()
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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