RichDispatchQueue

class RichDispatchQueue extends Proxy with RichExecutorTrait with RichDispatchObject

Enriches the DispatchQueue interfaces with additional Scala friendly methods.

attributes: final
linear super types: RichDispatchObject, RichExecutorTrait, Proxy, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. RichDispatchQueue
  2. RichDispatchObject
  3. RichExecutorTrait
  4. Proxy
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new RichDispatchQueue (actual: DispatchQueue)

Value Members

  1. def ! [T] (func: ⇒ T) : T @scala.util.continuations.cpsParam[Unit,Unit]

    Executes the supplied function on this executor.

    Executes the supplied function on this executor. If not called from a runnable being exectued in a Dispatch Queue, then is call blocks until continuation is executed. Otherwise, the continuation is resumed on the original calling dispatch queue once supplied function completes.

    definition classes: RichExecutorTrait
  2. def !! [T] (func: ⇒ T @scala.util.continuations.cpsParam[Unit,Unit]) : SettableFuture[T, T]

    Same as #future(=>T) except that the partial function is wrapped in a reset block.

    Same as #future(=>T) except that the partial function is wrapped in a reset block.

    definition classes: RichExecutorTrait
  3. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  4. 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
  5. def ## () : Int

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

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

    attributes: final
    definition classes: AnyRef
  8. def << (task: Runnable) : Unit

    Submits a runnable for asynchronous execution on a dispatch queue.

    Submits a runnable for asynchronous execution on a dispatch queue.

    task

    The runnable to submit to the dispatch queue.

    definition classes: RichExecutorTrait
  9. def <<| (task: Runnable) : RichDispatchQueue

    Submits a runnable for asynchronous execution on a dispatch queue if the queue is not currently executing, otherwise if the queue is currently executing, then the runnable is directly executed.

    Submits a runnable for asynchronous execution on a dispatch queue if the queue is not currently executing, otherwise if the queue is currently executing, then the runnable is directly executed.

    task

    The runnable to submit to execute

  10. 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
  11. 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
  12. def >>: (task: Runnable) : Unit

    A right-associative version of the #<<(Runnable) method

    A right-associative version of the #<<(Runnable) method

    definition classes: RichExecutorTrait
  13. def ^ (task: ⇒ Unit) : Unit

    Same as #apply(=>Unit)

    Same as #apply(=>Unit)

    definition classes: RichExecutorTrait
  14. val actual : DispatchQueue

    definition classes: RichDispatchQueueRichDispatchObject
  15. def after (time: Long, unit: TimeUnit)(task: ⇒ Unit) : Unit

    Submits a partial function for asynchronous execution on a dispatch queue after the specified time delay.

    Submits a partial function for asynchronous execution on a dispatch queue after the specified time delay.

    time

    The amount of time to delay

    unit

    The units of time the delay is specified in

    task

    The runnable to submit to the dispatch queue.

  16. def apply (task: ⇒ Unit) : Unit

    Submits a partial function for asynchronous execution on a dispatch queue.

    Submits a partial function for asynchronous execution on a dispatch queue.

    Calls to #execute(Runnable) always return immediately after the runnable has been submitted, and never wait for the runnable to be executed.

    The target queue determines whether the runnable will be invoked serially or concurrently with respect to other runnables submitted to that same queue. Serial queues are processed concurrently with with respect to each other.

    The system will retain this queue until the runnable has finished.

    task

    The function to submit to the dispatch queue.

    definition classes: RichExecutorTrait
  17. 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
  18. 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
  19. 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
  20. def equals (that: 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)).

    returns

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

    definition classes: Proxy → AnyRef → Any
  21. def execute (task: Runnable) : Unit

    attributes: protected
    definition classes: RichDispatchQueueRichExecutorTrait
  22. 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
  23. def flatFuture [T] (func: ⇒ Future[T]) : SettableFuture[T, T]

    definition classes: RichExecutorTrait
  24. def future [T] (func: ⇒ T) : SettableFuture[T, T]

    Executes the supplied function on the dispatch queue and returns a Future that can be used to wait on the future result of the function.

    Executes the supplied function on the dispatch queue and returns a Future that can be used to wait on the future result of the function.

    definition classes: RichExecutorTrait
  25. def getClass () : java.lang.Class[_]

    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
  26. 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: Proxy → AnyRef → Any
  27. 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
  28. def label : String

  29. def label_= (value: String) : Unit

  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 repeatAfter (time: Long, unit: TimeUnit)(task: ⇒ Unit) : Closeable

    Submits a partial function for repetitive asynchronous execution on a dispatch queue each time specified time delay elapses.

    Submits a partial function for repetitive asynchronous execution on a dispatch queue each time specified time delay elapses. Returns a Closable which when closed will stop future executions of the task.

    time

    The amount of time to delay

    unit

    The units of time the delay is specified in

    task

    The runnable to submit to the dispatch queue.

  34. def runnable (task: ⇒ Unit) : Runnable {...}

    Creates a Runnable object which executes the supplied partial function on this executor when run.

    Creates a Runnable object which executes the supplied partial function on this executor when run.

    definition classes: RichExecutorTrait
  35. def self : DispatchQueue

    definition classes: RichDispatchQueue → Proxy
  36. def sync [T] (func: ⇒ T) : T

    Executes the supplied function on the dispatch queue while blocking the calling thread as it waits for the response.

    Executes the supplied function on the dispatch queue while blocking the calling thread as it waits for the response.

    definition classes: RichExecutorTrait
  37. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  38. def target : DispatchQueue

    definition classes: RichDispatchObject
  39. def target_= (queue: DispatchQueue) : Unit

    definition classes: RichDispatchObject
  40. 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: Proxy → AnyRef → Any
  41. def wait () : Unit

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

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

    attributes: final
    definition classes: AnyRef
  44. def | (task: ⇒ Unit) : RichDispatchQueue

    Submits a runnable for asynchronous execution on a dispatch queue if the queue is not currently executing, otherwise if the queue is currently executing, then the runnable is directly executed.

    Submits a runnable for asynchronous execution on a dispatch queue if the queue is not currently executing, otherwise if the queue is currently executing, then the runnable is directly executed.

    task

    The runnable to submit to execute

  45. def |>>: (task: Runnable) : RichDispatchQueue

    A right-associative version of the #<<|(Runnable) method

    A right-associative version of the #<<|(Runnable) method

Inherited from RichDispatchObject

Inherited from RichExecutorTrait

Inherited from Proxy

Inherited from AnyRef

Inherited from Any