docs
0.5.0-SNAPSHOT
API
Generated with
Copyright (c) 2022, Yan Kun/Otavia Project
Copyright (c) 2022, Yan Kun/Otavia Project
docs/cc.otavia/cc.otavia.core/cc.otavia.core.actor/ChannelsActor

ChannelsActor

cc.otavia.core.actor.ChannelsActor
See theChannelsActor companion object
abstract class ChannelsActor[M <: Call]

IO-capable actor that manages Channel instances. Always fully drained during the event loop's IO phase (no time budget), ensuring IO responsiveness is never starved.

In addition to the standard message handling via resumeAsk / resumeNotice, ChannelsActor provides resumeChannelStack for processing channel-level IO stacks, and lifecycle hooks like afterChannelClosed and afterChannelRegistered for channel events.

Type parameters

M

the type of messages this actor can handle

Attributes

Companion
object
Graph
Supertypes
trait Actor[M]
class Object
trait Matchable
class Any
Known subtypes
class AcceptorActor[W]
class HttpServer
class HttpClient
class Client
class Connection
Show all

Members list

Value members

Concrete methods

def address: ActorAddress[M]

Alias for self — the typed address of this IO-capable actor.

Alias for self — the typed address of this IO-capable actor.

Attributes

def handler: Option[ChannelInitializer[_ <: Channel]]

Optional ChannelInitializer for pipeline setup. Override to provide a default handler.

Optional ChannelInitializer for pipeline setup. Override to provide a default handler.

Attributes

final def reactor: Reactor
override def self: ActorAddress[M]

Typed self-address. Separated from Actor by the +M/Address[-M] variance conflict.

Typed self-address. Separated from Actor by the +M/Address[-M] variance conflict.

Attributes

Definition Classes
AbstractActor

Inherited methods

final def actorId: Long

The unique id of this actor distributed by ActorSystem, when a actor instance is mounted to a ActorSystem, the actor system will distribute a unique id to the instance.

The unique id of this actor distributed by ActorSystem, when a actor instance is mounted to a ActorSystem, the actor system will distribute a unique id to the instance.

Attributes

Returns

id number

Inherited from:
Actor
final def autowire[A <: Actor[_] : ClassTag](qualifier: String): Address[MessageOf[A]]

Attributes

Inherited from:
Actor
final def autowire[A <: Actor[_] : ClassTag](qualifier: Option[String] = ..., remote: Option[String] = ...): Address[MessageOf[A]]

Attributes

Inherited from:
Actor
def batchable: Boolean

Whether this actor supports batch message processing. When true, the ActorSystem dispatches multiple messages in bulk rather than individually.

Whether this actor supports batch message processing. When true, the ActorSystem dispatches multiple messages in bulk rather than individually.

Attributes

Inherited from:
Actor
final override def context: ActorContext

Context of this actor. This method can only used after actor instance mount to actor system

Context of this actor. This method can only used after actor instance mount to actor system

Attributes

Definition Classes
AbstractActor -> Actor
Inherited from:
AbstractActor (hidden)
def maxBatchSize: Int

Maximum number of messages per batch. Used by the scheduling system.

Maximum number of messages per batch. Used by the scheduling system.

Attributes

Inherited from:
Actor
def maxFetchPerRunning: Int

Attributes

Inherited from:
Actor
def nice: Int

Attributes

Inherited from:
Actor
final protected def noticeSelfHead(call: Notice & M): Unit

Send a Notice to self, inserted at the head of the notice mailbox before all other pending notices.

Send a Notice to self, inserted at the head of the notice mailbox before all other pending notices.

Attributes

Inherited from:
AbstractActor (hidden)
protected def resumeAsk(stack: AskStack[M & Ask[_ <: Reply]]): StackYield

Handle an Ask message. Called on initial receipt and on each resume after an awaited reply completes.

Handle an Ask message. Called on initial receipt and on each resume after an awaited reply completes.

Match on stack.state to distinguish initial entry from resumed execution:

override protected def resumeAsk(stack: AskStack[MyAsk]): StackYield =
  stack.state match
    case _: StartState =>
      val state = FutureState[MyReply]()
      address.ask(MyRequest(), state.future)
      stack.suspend(state)
    case state: FutureState[MyReply] =>
      stack.return(state.future.getNow)

Attributes

Inherited from:
AbstractActor (hidden)
protected def resumeBatchAsk(stack: BatchAskStack[M & Ask[_ <: Reply]]): StackYield

Handle a batch of Ask messages in a single stack.

Handle a batch of Ask messages in a single stack.

Attributes

Inherited from:
AbstractActor (hidden)
protected def resumeBatchNotice(stack: BatchNoticeStack[M & Notice]): StackYield

Handle a batch of Notice messages in a single stack.

Handle a batch of Notice messages in a single stack.

Attributes

Inherited from:
AbstractActor (hidden)
protected def resumeNotice(stack: NoticeStack[M & Notice]): StackYield

Handle a Notice message. Called on initial receipt and on each resume.

Handle a Notice message. Called on initial receipt and on each resume.

Attributes

Inherited from:
AbstractActor (hidden)
final def system: ActorSystem

The ActorSystem of this actor instance is running

The ActorSystem of this actor instance is running

Attributes

Returns

ActorSystem

Inherited from:
Actor
final def timer: Timer

Attributes

Inherited from:
Actor

Inherited fields

val batchAskFilter: (Ask[_]) => Boolean

Filter function for batching Ask messages. Return true to include in batch.

Filter function for batching Ask messages. Return true to include in batch.

Attributes

Inherited from:
Actor
val batchNoticeFilter: Notice => Boolean

Filter function for batching Notice messages. Return true to include in batch.

Filter function for batching Notice messages. Return true to include in batch.

Attributes

Inherited from:
Actor
protected var logger: Logger

Attributes

Inherited from:
AbstractActor (hidden)
Generated with
Copyright (c) 2022, Yan Kun/Otavia Project
Copyright (c) 2022, Yan Kun/Otavia Project