Trait

org.specs2.codata.async.mutable

Topic

Related Doc: package mutable

Permalink

trait Topic[A] extends AnyRef

Represents topic, that asynchronously exchanges messages between one or more publisher(s) and one or more subscriber(s).

Guarantees: - Order of messages from publisher is guaranteed to be preserved to all subscribers - Messages from publishers may interleave in non deterministic order before they are read by subscribers - Once the subscriber is run it will receive all messages from all publishers starting with very first message arrived AFTER the subscriber was run

Please note that topic is active even when there are no publishers or subscribers attached to it. However once the close or fail is called all the publishers and subscribers will terminate or fail.

Once topic if closed or failed, all new publish or subscribe attempts will fail with reason that was used to close or fail the topic.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Topic
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def publish: Sink[Task, A]

    Permalink

    Gets publisher to this topic.

    Gets publisher to this topic. There may be multiple publishers to this topic.

  2. abstract def publishOne(a: A): Task[Unit]

    Permalink

    publishes single A to this topic.

  3. abstract def subscribe: Process[Task, A]

    Permalink

    Gets subscriber from this topic.

    Gets subscriber from this topic. There may be multiple subscribers to this topic. Subscriber subscribes and un-subscribes when it is run or terminated.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def close: Task[Unit]

    Permalink

    Will close this topic.

    Will close this topic. Once closed all publishers and subscribers are halted via End. When this topic is closed or failed this is no-op

    The resulting task is completed _after_ all publishers and subscribers are signalled with End

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def fail(rsn: Throwable): Task[Unit]

    Permalink

    Will fail this topic.

    Will fail this topic. Once failed all publishers and subscribers will terminate with cause err. When this topic is finished or failed this is no-op

    The resulting task is completed _after_ all publishers and subscribers are signalled with err

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def kill: Task[Unit]

    Permalink

    Causes this topic to be closed and all subscribers to this topic to be killed immediately.

    Causes this topic to be closed and all subscribers to this topic to be killed immediately.

    he resulting task is completed _after_ all publishers and subscribers are signalled with Kill

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped