scalaz.stream.async.mutable

Topic

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.

Source
Topic.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Topic
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

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

    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]

    publishes single A to this topic.

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

    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.

    returns

Concrete Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Topic[A] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Topic[A], B)

    Implicit information
    This member is added by an implicit conversion from Topic[A] to ArrowAssoc[Topic[A]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def close: Task[Unit]

    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

    returns

  11. def ensuring(cond: (Topic[A]) ⇒ Boolean, msg: ⇒ Any): Topic[A]

    Implicit information
    This member is added by an implicit conversion from Topic[A] to Ensuring[Topic[A]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: (Topic[A]) ⇒ Boolean): Topic[A]

    Implicit information
    This member is added by an implicit conversion from Topic[A] to Ensuring[Topic[A]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean, msg: ⇒ Any): Topic[A]

    Implicit information
    This member is added by an implicit conversion from Topic[A] to Ensuring[Topic[A]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean): Topic[A]

    Implicit information
    This member is added by an implicit conversion from Topic[A] to Ensuring[Topic[A]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  16. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  17. def fail(rsn: Throwable): Task[Unit]

    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

  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Topic[A] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  23. def kill: Task[Unit]

    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

    returns

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

    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  28. def toString(): String

    Definition Classes
    AnyRef → Any

  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. def →[B](y: B): (Topic[A], B)

    Implicit information
    This member is added by an implicit conversion from Topic[A] to ArrowAssoc[Topic[A]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Topic[A] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (topic: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Topic[A] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (topic: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Topic[A]

    Implicit information
    This member is added by an implicit conversion from Topic[A] to ArrowAssoc[Topic[A]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (topic: ArrowAssoc[Topic[A]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Topic[A]

    Implicit information
    This member is added by an implicit conversion from Topic[A] to Ensuring[Topic[A]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (topic: Ensuring[Topic[A]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Topic[A] to StringAdd

Inherited by implicit conversion any2stringfmt from Topic[A] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Topic[A] to ArrowAssoc[Topic[A]]

Inherited by implicit conversion any2Ensuring from Topic[A] to Ensuring[Topic[A]]

Ungrouped