Packages

  • package root
    Definition Classes
    root
  • package io

    This is the documentation for the ThreadCSO Library.

    This is the documentation for the ThreadCSO Library. Notable packages include:

    Definition Classes
    root
  • package threadcso

    The standard threadCSO API.

    The standard threadCSO API. Most modules using CSO will need only the declaration:

    import io.threadcso._

    The present version of the ThreadCSO library API is 1.2Rr (for some number r)

    The revision number (Rr) will change if bugs are corrected but the code remains consistent with the previous API. Its minor version number will change if there is a correction to the code that breaks consistency with the previous API. Its major version will change if there is a substantial change in the semantics of an important CSO construct.

    August 2017: changes 1.1 => 1.2

    • renaming of very many internal classes and packages
    • basic channel implementations are more efficient, in some case much more so
    • alternation reliability improved
    • debugger registration of alternations is no longer needed
    • home-grown semaphores can specify which component they are part of: this makes interpreting a stack backtrace very much easier
    • there is a flexible logging system that is compatible with the debugger

    April 2016: changes 1.0 => 1.1

    • Extended rendezvous read operator is now ?? (was ?)
    • Extended rendezvous read event notation is now =??=> (was =?=>>)
    • The notation inport ? f is now equivalent to f(inport?()) This makes for a tidier layout when the function f is an explicit functional expression.

    Feb 1 2017: changes 1.1R1 => 1.1R2

    • Removed dependencies on deprecated Java->Scala functions: replaced with .asJava
    @author Bernard Sufrin, Oxford
    $Revision: 286 $
    $Date: 2017-11-18 17:41:30 +0000 (Sat, 18 Nov 2017) $
    Definition Classes
    io
  • package channel

    Specifies primitive (non-alternation-capable) ports and channels; and implements several channel types.

    Specifies primitive (non-alternation-capable) ports and channels; and implements several channel types.

    Definition Classes
    threadcso
  • CLOSEDSTATE
  • Chan
  • Closed
  • InPort
  • N2N
  • N2NBuf
  • OneOne
  • OneOneBuf
  • OutPort
  • PortState
  • READYSTATE
  • SharedChan
  • SharedInPort
  • SharedOutPort
  • SyncChan
  • UNKNOWNSTATE

class N2N[T] extends OneOne[T] with SharedChan[T]

Synchronized shared channel to support communication between writers writers and readers readers. Closes completely when closeOut has been invoked writers times, or closeIn has been invoked readers times. If either writers or readers is non-positive, then the channel can be closed an unbounded number of times in the associated direction.

There is no check for writer-overtaking in an N2N(1,_) or for reader-overtaking in an N2N(_, 1). Both ends of an N2N behave as if they were shared.

The fairOut and fairIn parameters control whether processes are FIFO-queued to use the output/input side of the underlying synchronous channel when there is heavy contention. They both default to false -- for efficiency when there is little contention.

T

type of value transmitted by the buffer

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. N2N
  2. SharedChan
  3. SharedInPort
  4. SharedOutPort
  5. OneOne
  6. SyncChan
  7. Chan
  8. Debuggable
  9. Named
  10. OutPort
  11. InPort
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new N2N(writers: Int, readers: Int, name: String, fairOut: Boolean, fairIn: Boolean)

    writers

    expected number of writers

    readers

    expected number of readers

    name

    name of the buffer (for the debugger)

Value Members

  1. def !(value: T): Unit

    Output value to the port's channel.

    Output value to the port's channel.

    Definition Classes
    N2NOneOneOutPort
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def ?[U](f: (T) ⇒ U): U

    Ordinary rendezvous read & sync then compute

    Ordinary rendezvous read & sync then compute

    Definition Classes
    N2NOneOneInPort
  6. def ?(): T

    Block until a value is available for input, then read and return it.

    Block until a value is available for input, then read and return it.

    Definition Classes
    N2NOneOneInPort
  7. def ??[U](f: (T) ⇒ U): U

    Extended rendezvous read & compute, then sync

    Extended rendezvous read & compute, then sync

    Definition Classes
    N2NOneOneInPort
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def canInput: Boolean

    Returns false if no further input will be supplied by this port.

    Returns false if no further input will be supplied by this port. Returning true is not a guarantee that further input will be supplied.

    Definition Classes
    OneOneInPort
  10. def canOutput: Boolean

    Returns false if no further output can be accepted by this port.

    Returns false if no further output can be accepted by this port. Returning true is not a guarantee that further output will be accepted.

    Definition Classes
    OneOneOutPort
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def close(): Unit

    Signal that the channel is to be closed forthwith

    Signal that the channel is to be closed forthwith

    Definition Classes
    OneOneChan
  13. def closeIn(): Unit

    Signal that no further attempts will be made to input from the invoking thread: idempotent

    Signal that no further attempts will be made to input from the invoking thread: idempotent

    Definition Classes
    N2NOneOneInPort
  14. def closeOut(): Unit

    Signal that no further values will be output from the invoking thread: idempotent

    Signal that no further values will be output from the invoking thread: idempotent

    Definition Classes
    N2NOneOneOutPort
  15. def currentState: String

    Capture (an approximation to) the current state for debugger components

    Capture (an approximation to) the current state for debugger components

    Definition Classes
    OneOne
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def finishedRW: String

    Intelligible information about finished reads and writes

    Intelligible information about finished reads and writes

    Definition Classes
    OneOne
    Annotations
    @elidable( FINEST )
  20. def finishedRead: Long

    Increment count of finished reads

    Increment count of finished reads

    Definition Classes
    OneOne
    Annotations
    @elidable( FINEST )
  21. def finishedWrite: Long

    Increment count of finished writes

    Increment count of finished writes

    Definition Classes
    OneOne
    Annotations
    @elidable( FINEST )
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  23. def getWaiting: Seq[Thread]

    Return an approximation to the set of threads waiting for this channel.

    Return an approximation to the set of threads waiting for this channel. Intended to be invoked (from the debugger) only when system is quiescing or deadlocked.

    Definition Classes
    N2NDebuggable
  24. def hasState: Boolean

    This object has a state worth showing right now: false if showState will do no output.

    This object has a state worth showing right now: false if showState will do no output.

    Definition Classes
    Debuggable
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  26. def inPortEvent(portState: PortState): Unit

    The channel has just changed its state in a way that will affect inPortState

    The channel has just changed its state in a way that will affect inPortState

    Definition Classes
    Chan
  27. def inPortState: PortState

    READY if not closed and there's a writer waiting to sync (else CLOSED or UNKNOWN) (used only by alternation implementations)

    READY if not closed and there's a writer waiting to sync (else CLOSED or UNKNOWN) (used only by alternation implementations)

    Definition Classes
    OneOneInPort
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. val key: StateKey

    This object's key in the registry (if non-negative)

    This object's key in the registry (if non-negative)

    Definition Classes
    Debuggable
  30. def name: String

    Return the name of the object

    Return the name of the object

    Definition Classes
    Named
  31. def nameGenerator: NameGenerator

    Discover the name generator

    Discover the name generator

    Definition Classes
    N2NOneOneNamed
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def nothing: T

    The null value for this port -- equivalent to null.asInstanceOf[T].

    The null value for this port -- equivalent to null.asInstanceOf[T]. Useful to initialise variables that will in due course be assigned values by reading from the port.

    Definition Classes
    InPort
    Annotations
    @inline()
  34. final def notify(): Unit
    Definition Classes
    AnyRef
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  36. def outPortEvent(portState: PortState): Unit

    The channel has just changed its state in a way that will affect outPortState

    The channel has just changed its state in a way that will affect outPortState

    Definition Classes
    Chan
  37. def outPortState: PortState

    READY if not closed and there's a reader waiting and last writer has already synced (else CLOSED or UNKNOWN) (used only by alternation implementations)

    READY if not closed and there's a reader waiting and last writer has already synced (else CLOSED or UNKNOWN) (used only by alternation implementations)

    Definition Classes
    OneOneOutPort
  38. def readBefore(nsWait: Long): Option[T]

    Block until the earlier of the following events happens:

    Block until the earlier of the following events happens:

    - 1. A value, t, is available for input.

    - 2. ns nanoseconds have elapsed.

    Return Some(t) in case 1, and None in case 2.

    The longest possible wait that can specified this way is about 146 years.

    Definition Classes
    N2NOneOneInPort
  39. val reads: AtomicLong

    Count of the number of finished reads (writes)

    Count of the number of finished reads (writes)

    Definition Classes
    OneOne
  40. def register(): Unit

    Register this object

    Register this object

    Definition Classes
    Debuggable
  41. def setName(name: String): Unit

    Set the name using the name generator

    Set the name using the name generator

    Definition Classes
    Named
  42. def showState(out: PrintWriter): Unit

    Not thread-safe: best invoked only when system is quiescing (when the debugger is invoked).

    Not thread-safe: best invoked only when system is quiescing (when the debugger is invoked).

    Definition Classes
    N2NOneOneDebuggable
  43. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  44. def toString(): String
    Definition Classes
    OneOneNamed → AnyRef → Any
  45. def unregister(): Unit

    Unregister this object

    Unregister this object

    Definition Classes
    Debuggable
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. def withDebugger[T](condition: Boolean)(body: ⇒ T): T

    Conditionally register this object with the debugger only for the duration of the evaluation of body.

    Conditionally register this object with the debugger only for the duration of the evaluation of body. To be used as a last resort for the exasperated CSO toolkit debugger.

    Definition Classes
    Debuggable
  50. def withName(__name: String): Chan[T]

    Set the name of this object and return it

    Set the name of this object and return it

    Definition Classes
    Named
  51. def writeBefore(nsWait: Long)(value: T): Boolean

    Output value to the port's channel before nsWait has elapsed, and return true; or return false

    Output value to the port's channel before nsWait has elapsed, and return true; or return false

    Definition Classes
    N2NOneOneOutPort
  52. val writes: AtomicLong

    Count of the number of finished reads (writes)

    Count of the number of finished reads (writes)

    Definition Classes
    OneOne

Inherited from SharedChan[T]

Inherited from SharedInPort[T]

Inherited from SharedOutPort[T]

Inherited from OneOne[T]

Inherited from SyncChan[T]

Inherited from Chan[T]

Inherited from debug.REGISTRY.Debuggable

Inherited from Named[Chan[T]]

Inherited from OutPort[T]

Inherited from InPort[T]

Inherited from AnyRef

Inherited from Any

Ungrouped