Skip to main content

API map

NeedInterfaceSpawn
Class request, no replyIActor<TRequest>Spawn
Class request and replyIActor<TRequest, TResponse>Spawn / SpawnWithOptions
Struct request, no replyIActorStruct<TRequest>SpawnStruct
Struct request and replyIActorStruct<TRequest, TResponse>SpawnStruct / options overload
Batched requestsIActorAggregate<TRequest>SpawnAggregate
Batched requests and repliesIActorAggregate<TRequest, TResponse>SpawnAggregate / options overload

Reference operations

OperationMeaning
Send(message)Fire and forget.
Ask(message[, timeout])Enqueue and await a typed reply.
TrySend(message)Return whether a bounded actor admitted the message.
TryAsk(message, out reply)Check admission before allocating reply state.

Actor system operations

AreaAPIs
CreationSpawn*, Spawn*WithOptions
LookupGet, GetStruct
LifecycleShutdown*, GracefulShutdown*, Wait
SchedulingScheduleOnce*, StartPeriodicTimer*, StopPeriodicTimer, StopAllTimers, ScheduleShutdown
RoutingCreateRoundRobinRouter*, CreateConsistentHashRouter*

The source repository is the definitive API reference for overloads and generic constraints.