gopher

channels

package channels

Overview

Internals

Core entity is Continuated which provide iteratee-like structure for reading and writing. Instance of Continuated represent one step of computations and leave in queue inside ChannelProcessor or ChannelActor Selector transform Continuated to executed exclusive with each other within one selector. Also we have IdleDetector which determinate idle selectors and activer appropriative actions.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. channels
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class AsyncFullReadSelectorArgument[A, B](f: (ContRead[A, B]) ⇒ Option[(In[A]) ⇒ Future[Continuated[B]]]) extends ReadSelectorArgument[A, B] with Product with Serializable

  2. case class AsyncFullSkipSelectorArgument[A](f: (Skip[A]) ⇒ Option[Future[Continuated[A]]]) extends SkipSelectorArgument[A] with Product with Serializable

  3. case class AsyncFullWriteSelectorArgument[A, B](f: (ContWrite[A, B]) ⇒ Option[(A, Future[Continuated[B]])]) extends WriteSelectorArgument[A, B] with Product with Serializable

  4. case class AsyncNoGenReadSelectorArgument[A, B](f: (ContRead[A, B]) ⇒ (A) ⇒ Future[Continuated[B]]) extends ReadSelectorArgument[A, B] with Product with Serializable

  5. case class AsyncNoOptSkipSelectorArgument[A](f: (Skip[A]) ⇒ Future[Continuated[A]]) extends SkipSelectorArgument[A] with Product with Serializable

  6. case class AsyncNoOptWriteSelectorArgument[A, B](f: (ContWrite[A, B]) ⇒ (A, Future[Continuated[B]])) extends WriteSelectorArgument[A, B] with Product with Serializable

  7. case class AsyncNoOptionReadSelectorArgument[A, B](f: (ContRead[A, B]) ⇒ (In[A]) ⇒ Future[Continuated[B]]) extends ReadSelectorArgument[A, B] with Product with Serializable

  8. case class AsyncPairReadSelectorArgument[A, B](f: (A, ContRead[A, B]) ⇒ Future[Continuated[B]]) extends ReadSelectorArgument[A, B] with Product with Serializable

  9. class ChannelActor[A] extends Actor

    ChannelActor - actor, which leave

  10. sealed trait ChannelActorMessage extends AnyRef

  11. case class ChannelCloseProcessed(nElements: Int) extends ChannelActorMessage with Product with Serializable

    result of CloseChannelRead, return number of elements left to read

  12. class ChannelProcessor extends Actor

  13. class ChannelSupervisor extends Actor

  14. case class CloseChannel(id: Long) extends Product with Serializable

  15. case class ClosedChannelRead(cont: ContRead[_, _]) extends ChannelActorMessage with Product with Serializable

    this is message wich send to ChannelActor, when we know, that channel is closed.

    this is message wich send to ChannelActor, when we know, that channel is closed. In such case, we don't konw: is actor stopped or not, So, we say this message (instead read) and wait for reply. If reply is not received within given timeout: think that channel is-dead.

  16. case class ContRead[A, B](function: (ContRead[A, B]) ⇒ Option[(In[A]) ⇒ Future[Continuated[B]]], channel: Input[A], flowTermination: FlowTermination[B]) extends FlowContinuated[B] with Product with Serializable

    read A and compute B as result.

  17. case class ContWrite[A, B](function: (ContWrite[A, B]) ⇒ Option[(A, Future[Continuated[B]])], channel: Output[A], flowTermination: FlowTermination[B]) extends FlowContinuated[B] with Product with Serializable

    write A and compute B as result

  18. sealed trait Continuated[+A] extends AnyRef

    represent continuated computation from A to B.

  19. case class Done[A](result: A, flowTermination: FlowTermination[A]) extends FlowContinuated[A] with Product with Serializable

  20. class DuppedInput[A] extends AnyRef

  21. sealed trait FlowContinuated[A] extends Continuated[A]

  22. trait ForeverSelectorBuilder extends SelectorBuilder[Unit]

    Builder for 'forever' selector.

    Builder for 'forever' selector. Can be obtained as gopherApi.select.forever.

  23. class FutureInput[A] extends Input[A]

    Future[A], represented as input which produce a value when completed, after this closes.

    Future[A], represented as input which produce a value when completed, after this closes. If evaluation of feature is unsuccessful (i.e. failure), than appropriative exception is thrown during reading.

    Can be obtained from gopherApi.

    import gopherApi._
    
    val myInput = futureInput(future)
    select.forever{
       case x: myInput.read => Console.println(s"we receive value from future: ${x}")
                             implicitly[FlowTermination[Unit]].doExit(())
       case x: myChannel.read => Console.println(s"value from channel: ${x}")
    }

    Also it is possiblt to direclty read from future in case guard:

    select.forever{
       case x: T if (x==future.read) => Console.println(s"we receive value from future: ${x}")
       case x: T if (x==channel.read) => Console.println(s"value from channel: ${x}")
    }
  24. class IOChannel[A] extends Input[A] with Output[A]

  25. class IdleDetector extends AnyRef

  26. trait Input[A] extends AnyRef

    Entity, from which we can read objects of type A.

  27. class InputWithTimeouts[A] extends AnyRef

    Wrap origin input into input, which produce 'timeout' value into timeouts channel when reading from wrapped channel take more time than timeout .

    Wrap origin input into input, which produce 'timeout' value into timeouts channel when reading from wrapped channel take more time than timeout .

    See also

    InputChannel.withInputTimeouts

  28. case class NewChannel(id: Long, capacity: Int) extends Product with Serializable

  29. trait OnceSelectorBuilder[T] extends SelectorBuilder[T]

    Builder for 'once' selector.

    Builder for 'once' selector. Can be obtained as gopherApi.select.once.

  30. class OrInput[A] extends Input[A]

    Input, which combine two other inputs.

    Input, which combine two other inputs.

    can be created with '|' operator.

    val x = read(x|y)
  31. trait Output[A] extends AnyRef

    Entity, where we can write objects of type A.

  32. class OutputWithTimeouts[A] extends AnyRef

  33. trait PromiseFlowTermination[A] extends FlowTermination[A]

  34. sealed trait ReadSelectorArgument[A, B] extends AnyRef

  35. class SelectFactory extends AnyRef

    Factory for select instantiation.

    Factory for select instantiation. Can be obtained via gopherAPI

    val selector = gopherApi.select.forever
    for(s <- selector) ...
  36. class Selector[A] extends PromiseFlowTermination[A]

  37. trait SelectorBuilder[A] extends AnyRef

  38. case class Skip[A](function: (Skip[A]) ⇒ Option[Future[Continuated[A]]], flowTermination: FlowTermination[A]) extends FlowContinuated[A] with Product with Serializable

    skip (i.e.

    skip (i.e. do some operation not related to reading or writing.)

  39. sealed trait SkipSelectorArgument[A] extends AnyRef

  40. case class SyncPairReadSelectorArgument[A, B](f: (A, ContRead[A, B]) ⇒ Continuated[B]) extends ReadSelectorArgument[A, B] with Product with Serializable

  41. case class SyncReadSelectorArgument[A, B](f: (ContRead[A, B]) ⇒ (In[A]) ⇒ Continuated[B]) extends ReadSelectorArgument[A, B] with Product with Serializable

  42. case class SyncSelectorArgument[A](f: (Skip[A]) ⇒ Continuated[A]) extends SkipSelectorArgument[A] with Product with Serializable

  43. case class SyncWriteSelectorArgument[A, B](f: (ContWrite[A, B]) ⇒ (A, Continuated[B])) extends WriteSelectorArgument[A, B] with Product with Serializable

  44. sealed trait WriteSelectorArgument[A, B] extends AnyRef

  45. class ZippedInput[A, B] extends Input[(A, B)]

Value Members

  1. object ChannelClose extends ChannelActorMessage with Product with Serializable

  2. object ChannelRefDecrement extends ChannelActorMessage with Product with Serializable

    this message is send, when all references to some instance of this channel are unreachable, so if we have no other instances (i.e.

    this message is send, when all references to some instance of this channel are unreachable, so if we have no other instances (i.e. remote channel incarnation), than we must destroy channel.

  3. object ChannelRefIncrement extends ChannelActorMessage with Product with Serializable

    this message is send, when we create new remote reference to channel, backed by this actor.

  4. object ContRead extends Serializable

  5. object CurrentFlowTermination

  6. object GracefullChannelStop extends ChannelActorMessage with Product with Serializable

    When we decide to stop channel, do it via special message, to process one after messages, which exists now in queue.

    When we decide to stop channel, do it via special message, to process one after messages, which exists now in queue.

    Note, that channel-stop messages can be send only from ChannelActor

  7. object Input

  8. object InputMacro

  9. object Never extends Continuated[Nothing] with Product with Serializable

    never means the end of conversation

  10. object Output

  11. object PromiseFlowTermination

  12. object SelectorBuilder

  13. object ZippedInput

Inherited from AnyRef

Inherited from Any

Ungrouped