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 alternation
    Definition Classes
    threadcso
  • package channel

    This package defines channels that can participate in the CSO alternation constructs.

    This package defines channels that can participate in the CSO alternation constructs.

    I have separated syntax and semantics as far as was practical, given my reluctance to get embroiled with the Scala macro system (it was unstable when the CSO work started)

    An io.threadcso.alternation.Run embodies the state of execution of an alternation.

    The guarded event notation: (guard && port) =...=> { .... } is parsed to a Guarded...Port =...=> ... then to an appropriate class of event. The former is achieved by defining the implicit class io.threadcso.Guarded in the top-level CSO API. This provides the appropriate extension to Boolean.

    @author Bernard Sufrin, Oxford
    $Revision: 240 $
    $Date: 2017-10-13 18:12:11 +0100 (Fri, 13 Oct 2017) $
    Definition Classes
    alternation
  • AltCapableChannel
  • Chan
  • GuardedChan
  • GuardedInPort
  • GuardedOutPort
  • InPort
  • N2N
  • N2NBuf
  • OneOne
  • OneOneBuf
  • OutPort
  • SharedAltCapableChannel
t

io.threadcso.alternation.channel

AltCapableChannel

trait AltCapableChannel[T] extends Chan[T]

Mixin for channels that are capable of participating in alternations. Deals with registration/unregistration of a channel with a running alternation, and with detailed logging (when not elided) of port-state changes. Typical examples of its use can be found in the definitions of channel constructors such as io.threadcso.alternation.channel.OneOne and io.threadcso.alternation.channel.N2NBuf.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AltCapableChannel
  2. Chan
  3. OutPort
  4. InPort
  5. Chan
  6. Debuggable
  7. Named
  8. OutPort
  9. InPort
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def !(value: T): Unit

    Output value to the port's channel.

    Output value to the port's channel.

    Definition Classes
    OutPort
  2. abstract def ?[U](f: (T) ⇒ U): U

    Block until a value t is available for input, then return f(t) -- equivalent to f(?()).

    Block until a value t is available for input, then return f(t) -- equivalent to f(?()).

    Definition Classes
    InPort
  3. abstract 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
    InPort
  4. abstract def ??[U](f: (T) ⇒ U): U

    Block until a value t is available for input, then return f(t).

    Block until a value t is available for input, then return f(t). If the inport is provided by a synchronized channel then synchronisation with the termination of the sender's ! is at the termination of the computation of f(t) (this is sometimes called an extended rendezvous).

    Definition Classes
    InPort
  5. abstract 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
    InPort
  6. abstract 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
    OutPort
  7. abstract def close(): Unit

    Signal that the channel is to be closed forthwith

    Signal that the channel is to be closed forthwith

    Definition Classes
    Chan
  8. abstract 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
    InPort
  9. abstract 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
    OutPort
  10. abstract def inPortState: PortState

    Current state of this port: for alternation implementations

    Current state of this port: for alternation implementations

    Definition Classes
    InPort
  11. abstract def nameGenerator: NameGenerator

    Discover the name generator

    Discover the name generator

    Definition Classes
    Named
  12. abstract def outPortState: PortState

    Current state of this port: for alternation implementations

    Current state of this port: for alternation implementations

    Definition Classes
    OutPort
  13. abstract def readBefore(ns: 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
    InPort
  14. abstract 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
    OutPort

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def =!=>(gen: ⇒ T): OutPortEvent[T]

    Construct an unconditional output event for use in an alternation.

    Construct an unconditional output event for use in an alternation.

    Definition Classes
    ChanOutPort
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def =?=>(body: (T) ⇒ Unit): InPortEvent[T]

    Construct an unconditional input event for use in an alternation.

    Construct an unconditional input event for use in an alternation.

    Definition Classes
    ChanInPort
  6. def =??=>(body: (T) ⇒ Unit): InPortEventExtended[T]

    Construct an unconditional extended-rendezvous input event for use in an alternation.

    Construct an unconditional extended-rendezvous input event for use in an alternation.

    Definition Classes
    ChanInPort
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  13. def getWaiting: Seq[Thread]

    Return a sequence of the threads currently waiting for this object, if any.

    Return a sequence of the threads currently waiting for this object, if any. Default is the empty sequence.

    Definition Classes
    Debuggable
  14. 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
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  16. val inPort: InPort[T]

    this as an InPort

    this as an InPort

    Definition Classes
    Chan
  17. 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
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. 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
  20. def logLastInState(state: PortState): Unit

    For detailed logging

    For detailed logging

    Annotations
    @inline() @elidable( FINEST )
  21. def logLastOutState(state: PortState): Unit

    For detailed logging

    For detailed logging

    Annotations
    @inline() @elidable( FINEST )
  22. def logLastReg(port: String, unreg: Boolean, state: PortState): Unit

    For detailed logging

    For detailed logging

    Annotations
    @inline() @elidable( FINEST )
  23. def name: String

    Return the name of the object

    Return the name of the object

    Definition Classes
    Named
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. 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()
  26. final def notify(): Unit
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  28. val outPort: OutPort[T]

    this as an OutPort

    this as an OutPort

    Definition Classes
    Chan
  29. 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
  30. def register(): Unit

    Register this object

    Register this object

    Definition Classes
    Debuggable
  31. def registerIn(alt: Runnable, index: Int): PortState

    Register an input event with this channel, and return the port state

    Register an input event with this channel, and return the port state

    Definition Classes
    AltCapableChannelInPort
  32. def registerOut(alt: Runnable, index: Int): PortState

    Register an output event with this channel, and return the port state

    Register an output event with this channel, and return the port state

    Definition Classes
    AltCapableChannelOutPort
  33. def setInPortStateImp(portState: PortState): Unit

    Standard implementation of setInPortState for alt-able channel

    Standard implementation of setInPortState for alt-able channel

    Attributes
    protected
    Annotations
    @inline()
  34. def setName(name: String): Unit

    Set the name using the name generator

    Set the name using the name generator

    Definition Classes
    Named
  35. def setOutPortStateImp(portState: PortState): Unit

    Standard implementation of setOutPortState for alt-able channel

    Standard implementation of setOutPortState for alt-able channel

    Attributes
    protected
    Annotations
    @inline()
  36. def showState(out: PrintWriter): Unit

    For use by the debugger

    For use by the debugger

    Definition Classes
    AltCapableChannelDebuggable
  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. val theIndex: Int

    Index of this channel in the currently-registered running alternation

    Index of this channel in the currently-registered running alternation

    Attributes
    protected[this]
  39. def toString(): String
    Definition Classes
    Named → AnyRef → Any
  40. def unregister(): Unit

    Unregister this object

    Unregister this object

    Definition Classes
    Debuggable
  41. def unregisterIn(): PortState

    Unregister an input event with this channel, and return the port state

    Unregister an input event with this channel, and return the port state

    Definition Classes
    AltCapableChannelInPort
  42. def unregisterOut(): PortState

    Unregister an output event with this channel, and return the port state

    Unregister an output event with this channel, and return the port state

    Definition Classes
    AltCapableChannelOutPort
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. 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
  47. def withName(__name: String): channel.Chan[T]

    Set the name of this object and return it

    Set the name of this object and return it

    Definition Classes
    Named

Inherited from Chan[T]

Inherited from OutPort[T]

Inherited from InPort[T]

Inherited from channel.Chan[T]

Inherited from debug.REGISTRY.Debuggable

Inherited from Named[channel.Chan[T]]

Inherited from channel.OutPort[T]

Inherited from channel.InPort[T]

Inherited from AnyRef

Inherited from Any

Ungrouped