scala.actors

Actor

object Actor extends Combinators

The Actor object provides functions for the definition of actors, as well as actor operations, such asreceive, react, reply, etc.

go to: companion
linear super types: Combinators, AnyRef, Any
source: Actor.scala
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Actor
  2. Combinators
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def ? : Any

    Receives the next message from the mailbox of the current actorself.

    Receives the next message from the mailbox of the current actorself.

  9. object State extends Enumeration

    An actor state.

  10. def actor (body: ⇒ Unit) : Actor

    This is a factory method for creating actors.

    This is a factory method for creating actors.

    The following example demonstrates its usage:

    import scala.actors.Actor._
    ...
    val a = actor {
      ...
    }
    
    body

    the code block to be executed by the newly created actor

    returns

    the newly created actor. Note that it is automatically started.

  11. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  12. def clearSelf : Unit

    Removes any reference to an Actor instance currently stored in thread-local storage.

    Removes any reference to an Actor instance currently stored in thread-local storage.

    This allows to release references from threads that are potentially long-running or being re-used (e.g. inside a thread pool). Permanent references in thread-local storage are a potential memory leak.

  13. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  14. def continue : Unit

    Continues with the execution of the closure registered as continuation following andThen.

    Continues with the execution of the closure registered as continuation following andThen. Continues with the execution of the next loop iteration when invoked inside the body of loopor loopWhile.

    definition classes: Combinators
  15. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  16. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  17. def eventloop (f: PartialFunction[Any, Unit]) : Nothing

  18. def exit () : Nothing

    Terminates execution of self with the following effect on linked actors:

    Terminates execution of self with the following effect on linked actors:

    For each linked actor a with trapExit set to true, send message Exit(self, 'normal) to a.

  19. def exit (reason: AnyRef) : Nothing

    Terminates execution of self with the following effect on linked actors:

    Terminates execution of self with the following effect on linked actors:

    For each linked actor a with trapExit set to true, send message Exit(self, reason) to a.

    For each linked actor a with trapExit set to false (default), call a.exit(reason) if reason != 'normal.

  20. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  21. def getClass () : java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  22. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  23. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  24. def link (body: ⇒ Unit) : Actor

    Links self to the actor defined by body.

    Links self to the actor defined by body.

    body

    the body of the actor to link to

    returns

    the parameter actor

  25. def link (to: AbstractActor) : AbstractActor

    Links self to actor to.

    Links self to actor to.

    to

    the actor to link to

    returns

    the parameter actor

  26. def loop (body: ⇒ Unit) : Unit

    Repeatedly executes body.

    Repeatedly executes body.

    body

    the block to be executed

    definition classes: Combinators
  27. def loopWhile (cond: ⇒ Boolean)(body: ⇒ Unit) : Unit

    Repeatedly executes body while the condition cond is true.

    Repeatedly executes body while the condition cond is true.

    cond

    the condition to test

    body

    the block to be executed

    definition classes: Combinators
  28. def mailboxSize : Int

    Returns the number of messages in self's mailbox

    Returns the number of messages in self's mailbox

    returns

    the number of messages in self's mailbox

  29. implicit def mkBody [a] (body: ⇒ a) : Body[a]

    Enables the composition of suspendable closures using andThen,loop, loopWhile, etc.

    Enables the composition of suspendable closures using andThen,loop, loopWhile, etc.

    attributes: implicit
    definition classes: Actor → Combinators
  30. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  31. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  32. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  33. def react (f: PartialFunction[Any, Unit]) : Nothing

    Lightweight variant of receive.

    Lightweight variant of receive.

    Actions in f have to contain the rest of the computation of self, as this method will never return.

    f

    a partial function specifying patterns and actions

    returns

    this function never returns

  34. def reactWithin (msec: Long)(f: PartialFunction[Any, Unit]) : Nothing

    Lightweight variant of receiveWithin.

    Lightweight variant of receiveWithin.

    Actions in f have to contain the rest of the computation of self, as this method will never return.

    msec

    the time span before timeout

    f

    a partial function specifying patterns and actions

    returns

    this function never returns

  35. def reactor (body: ⇒ Responder[Unit]) : Actor

    This is a factory method for creating actors whose body is defined using a Responder.

    This is a factory method for creating actors whose body is defined using a Responder.

    The following example demonstrates its usage:

    import scala.actors.Actor._
    import Responder.exec
    ...
    val a = reactor {
      for {
        res <- b !! MyRequest;
        if exec(println("result: "+res))
      } yield {}
    }
    
    body

    the Responder to be executed by the newly created actor

    returns

    the newly created actor. Note that it is automatically started.

  36. def readResolve () : AnyRef

    attributes: protected
  37. def receive [A] (f: PartialFunction[Any, A]) : A

    Receives a message from the mailbox ofself.

    Receives a message from the mailbox ofself. Blocks if no message matching any of the cases of f can be received.

    f

    a partial function specifying patterns and actions

    returns

    the result of processing the received message

  38. def receiveWithin [R] (msec: Long)(f: PartialFunction[Any, R]) : R

    Receives a message from the mailbox ofself. Blocks at most msecmilliseconds if no message matching any of the cases off can be received.

    Receives a message from the mailbox ofself. Blocks at most msecmilliseconds if no message matching any of the cases off can be received. If no message could be received the TIMEOUT action is executed if specified.

    msec

    the time span before timeout

    f

    a partial function specifying patterns and actions

    returns

    the result of processing the received message

  39. def reply () : Unit

    Send () to the actor waiting in a call to!?.

    Send () to the actor waiting in a call to!?.

  40. def reply (msg: Any) : Unit

    Send msg to the actor waiting in a call to!?.

    Send msg to the actor waiting in a call to!?.

  41. def resetProxy : Unit

    Resets an actor proxy associated with the current thread.

    Resets an actor proxy associated with the current thread. It replaces the implicit ActorProxy instance of the current thread (if any) with a new instance.

    This permits to re-use the current thread as an actor even if its ActorProxy has died for some reason.

  42. def respondOn [A, B] (fun: (PartialFunction[A, Unit]) ⇒ Nothing) : (PartialFunction[A, B]) ⇒ Responder[B]

    Converts a synchronous event-based operation into an asynchronous Responder.

    Converts a synchronous event-based operation into an asynchronous Responder.

    The following example demonstrates its usage:

    val adder = reactor {
      for {
        _ <- respondOn(react) { case Add(a, b) => reply(a+b) }
      } yield {}
    }
    
  43. def self : Actor

    Returns the currently executing actor.

    Returns the currently executing actor. Should be used instead of this in all blocks of code executed by actors.

    returns

    returns the currently executing actor.

  44. def sender : OutputChannel[Any]

    Returns the actor which sent the last received message.

    Returns the actor which sent the last received message.

  45. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  46. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  47. def unlink (from: AbstractActor) : Unit

    Unlinks self from actor from.

    Unlinks self from actor from.

    from

    the actor to unlink from

  48. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  49. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  50. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from Combinators

Inherited from AnyRef

Inherited from Any