package internalpb

Get desktop application:
View/edit binary Protocol Buffers messages

Ack advances the producer's confirmed sequence without granting demand.

Used in: DeliveryEnvelope

• string session_id = 1

  Identifies the producer controller incarnation.

• string registration_nonce = 2

  Identifies the accepted consumer registration.

• int64 confirmed_seq = 3

  Specifies the highest sequence processed by the consumer.

Actor represents the actor information on the wire.

Used in: PeerState, PersistPeerActor, RelocateBatchRequest

• string address = 1

  Specifies the actor address

• string type = 2

  Specifies the actor type

• optional SingletonSpec singleton = 3

  Specifies if the actor is a singleton

• bool relocatable = 4

  Specifies if the actor is disabled for relocation

• optional PassivationStrategy passivation_strategy = 5

  Specifies the passivation strategy

• repeated Dependency dependencies = 6

  Specifies the dependencies

• bool enable_stash = 7

  States whether the actor will require a stash buffer

• optional string role = 8

  Specifies the role the actor belongs to

• optional SupervisorSpec supervisor = 9

  Specifies the supervisor configuration when explicitly set

• optional ReentrancyConfig reentrancy = 10

  Specifies the reentrancy configuration when explicitly set

• optional google.protobuf.Duration init_timeout = 11

  Specifies the init timeout override when explicitly set. When unset, the hosting node's system-wide init timeout is used.

• string incarnation_id = 12

  Identifies this actor incarnation

• optional ReliableDeliveryConfig reliable_delivery = 13

  Specifies the reliable-delivery configuration when explicitly set

• optional ReliableCompanionSpec reliable_companion = 14

  Marks an endpoint-owned reliable-delivery controller record

AsyncRequest wraps a user message with correlation and reply metadata.

• string correlation_id = 1

  correlation_id links requests to responses.

• string reply_to = 2

  reply_to identifies the requester, interpreted according to reply_kind.

• optional google.protobuf.Any message = 3

  message is the original user payload.

• ReplyKind reply_kind = 4

  reply_kind selects how reply_to is interpreted.

AsyncResponse delivers a response or error for an AsyncRequest.

• string correlation_id = 1

  correlation_id matches the original AsyncRequest.

• optional google.protobuf.Any message = 2

  message is the successful response payload.

• string error = 3

  error is set when the request fails or times out.

CRDTData is a union of all CRDT state representations.

Used in: CRDTDelta, CRDTFullStateEntry, CRDTReadResponse, CRDTSnapshotEntry, ORMapData.ORMapEntry

• oneof type

  • GCounterData g_counter = 1

  • PNCounterData pn_counter = 2

  • LWWRegisterData lww_register = 3

  • ORSetData or_set = 4

  • ORMapData or_map = 5

  • FlagData flag = 6

  • MVRegisterData mv_register = 7

CRDTDataType identifies the CRDT type for serialization and type validation.

Used in: CRDTKey

• CRDT_DATA_TYPE_UNSPECIFIED = 0

• CRDT_DATA_TYPE_G_COUNTER = 1

• CRDT_DATA_TYPE_PN_COUNTER = 2

• CRDT_DATA_TYPE_LWW_REGISTER = 3

• CRDT_DATA_TYPE_OR_SET = 4

• CRDT_DATA_TYPE_OR_MAP = 5

• CRDT_DATA_TYPE_FLAG = 6

• CRDT_DATA_TYPE_MV_REGISTER = 7

CRDTDelta is the delta message published to the shared goakt.crdt.deltas topic via TopicActor. The key is carried inside the payload so that receivers can route the delta to the correct local store entry.

Used in: CRDTDeltaBatch

• optional CRDTKey key = 1

  Specifies the CRDT key this delta belongs to.

• string origin_node = 2

  Specifies the node that originated this delta.

• optional CRDTData data = 3

  Specifies the delta state.

CRDTDeltaBatch is a batched collection of deltas and tombstones forwarded between CRDT bridge actors across datacenters.

• repeated CRDTDelta deltas = 1

  Specifies the deltas accumulated since the last flush.

• repeated CRDTTombstone tombstones = 2

  Specifies the tombstones accumulated since the last flush.

• optional DataCenter origin_dc = 3

  Specifies the datacenter that originated this batch.

• int64 sent_at_nanos = 4

  Specifies when the batch was sent in nanoseconds since epoch.

CRDTDigest is exchanged between Replicators during anti-entropy.

• repeated CRDTDigestEntry entries = 1

  Specifies the digest entries.

CRDTDigestEntry is a single entry in an anti-entropy digest.

Used in: CRDTDigest

• optional CRDTKey key = 1

  Specifies the CRDT key.

• uint64 version = 2

  Specifies the local version of this key.

CRDTFullState is the anti-entropy response containing full state for divergent keys.

• repeated CRDTFullStateEntry entries = 1

  Specifies the full state entries.

CRDTFullStateEntry is a single key's full state in an anti-entropy response.

Used in: CRDTFullState

• optional CRDTKey key = 1

  Specifies the CRDT key.

• optional CRDTData data = 2

  Specifies the full CRDT state.

CRDTKey is a typed, serializable CRDT key.

Used in: CRDTDelta, CRDTDigestEntry, CRDTFullStateEntry, CRDTReadRequest, CRDTReadResponse, CRDTSnapshotEntry, CRDTTombstone

• string id = 1

  Specifies the key's string identifier.

• CRDTDataType data_type = 2

  Specifies the CRDT data type this key holds.

CRDTReadRequest asks a peer Replicator for its local value of a key during a coordinated read (ReadFrom: Majority or All).

• optional CRDTKey key = 1

  Specifies the CRDT key to read.

• string from_node = 2

  Specifies the node requesting the read.

CRDTReadResponse returns a peer Replicator's local value for a key in response to a CRDTReadRequest.

• optional CRDTKey key = 1

  Specifies the CRDT key.

• optional CRDTData data = 2

  Specifies the local CRDT state. Nil if the key is not found.

• string from_node = 3

  Specifies the node returning the response.

CRDTSnapshotEntry is a single key's state in a durable BoltDB snapshot.

• optional CRDTKey key = 1

  Specifies the CRDT key.

• optional CRDTData data = 2

  Specifies the full CRDT state.

• uint64 version = 3

  Specifies the local version counter.

CRDTTombstone marks a deleted CRDT key.

Used in: CRDTDeltaBatch

• optional CRDTKey key = 1

  Specifies the deleted key.

• int64 deleted_at_nanos = 2

  Specifies when the key was deleted in nanoseconds since epoch.

• string deleted_by_node = 3

  Specifies the node that performed the deletion.

ChunkInfo marks one part of a chunked payload. Its absence on a SequencedMessage means the payload is a complete serialized message.

Used in: SequencedMessage

• bool first = 1

  Marks the first chunk of a chunked message.

• bool last = 2

  Marks the last chunk of a chunked message.

Used in: Error

• CODE_INTERNAL = 0

• CODE_NOT_FOUND = 1

• CODE_ALREADY_EXISTS = 2

• CODE_INVALID_ARGUMENT = 3

• CODE_UNAVAILABLE = 4

• CODE_FAILED_PRECONDITION = 5

• CODE_INTERNAL_ERROR = 6

• CODE_DEADLINE_EXCEEDED = 7

• CODE_RESOURCE_EXHAUSTED = 8

• CODE_CANCELED = 9

• CODE_UNKNOWN = 10

CompressionCodec is the whole-connection compression wrapper negotiated during the duplex handshake. Both peers wrap the connection only after HELLO/HELLO_ACK completes.

Used in: Hello

• COMPRESSION_CODEC_NONE = 0

• COMPRESSION_CODEC_GZIP = 1

• COMPRESSION_CODEC_ZSTD = 2

• COMPRESSION_CODEC_BROTLI = 3

ControlPlaneEvent represents a control plane change notification.

• ControlPlaneEventType type = 1

  Type describes the change type.

• optional DataCenterRecord record = 2

  Record carries the updated record.

ControlPlaneEventType describes the kind of change for a watch event.

Used in: ControlPlaneEvent

• CONTROL_PLANE_EVENT_TYPE_UNSPECIFIED = 0

  CONTROL_PLANE_EVENT_TYPE_UNSPECIFIED means the event type is unknown.

• CONTROL_PLANE_EVENT_TYPE_UPSERT = 1

  CONTROL_PLANE_EVENT_TYPE_UPSERT indicates a record was created or updated.

• CONTROL_PLANE_EVENT_TYPE_DELETE = 2

  CONTROL_PLANE_EVENT_TYPE_DELETE indicates a record was removed or expired.

DataCenter defines metadata used for multi-DC routing and placement.

Used in: CRDTDeltaBatch, DataCenterRecord

• string name = 1

  Name is the datacenter identifier.

• string region = 2

  Region optionally groups datacenters into a higher-level region.

• string zone = 3

  Zone optionally specifies an availability zone.

• map<string, string> labels = 4

  Labels provides routing metadata for placement and policy decisions.

DataCenterRecord represents the control plane view of a datacenter.

Used in: ControlPlaneEvent

• string id = 1

  Id is the stable, immutable identifier for the record.

• optional DataCenter data_center = 2

  DataCenter holds the datacenter metadata.

• repeated string endpoints = 3

  Endpoints is the list of advertised addresses for routing.

• DataCenterState state = 4

  State reflects the record lifecycle state.

• optional google.protobuf.Timestamp lease_expiry = 5

  LeaseExpiry is the time when the record becomes inactive if not renewed.

• uint64 version = 6

  Version is a monotonic revision for conflict-free updates.

DataCenterState defines the lifecycle state for a DataCenterRecord.

Used in: DataCenterRecord

• DATA_CENTER_STATE_UNSPECIFIED = 0

  DATA_CENTER_STATE_UNSPECIFIED means the state is unknown.

• DATA_CENTER_STATE_REGISTERED = 1

  DATA_CENTER_STATE_REGISTERED indicates the record is registered but not active.

• DATA_CENTER_STATE_ACTIVE = 2

  DATA_CENTER_STATE_ACTIVE indicates the record is eligible for routing.

• DATA_CENTER_STATE_DRAINING = 3

  DATA_CENTER_STATE_DRAINING indicates new placements should be avoided.

• DATA_CENTER_STATE_INACTIVE = 4

  DATA_CENTER_STATE_INACTIVE indicates the record is not eligible for routing.

• string peer_address = 1

  Specifies the peer address

DeliveryEnvelope identifies the reliable-delivery command in a custom serializer frame.

• oneof command

  • RegisterConsumer register_consumer = 1

    Carries a consumer registration attempt.

  • RegistrationAck registration_ack = 2

    Carries a producer registration response.

  • Request request = 3

    Carries consumer demand and a confirmation watermark.

  • Ack ack = 4

    Carries a confirmation watermark without additional demand.

  • SequencedMessage sequenced_message = 5

    Carries one sequenced application message.

Dependency represents a single actor dependency definition. This message is used to capture all the necessary metadata and initialization details required to recreate a dependency instance during the actor's lifecycle.

Used in: Actor, Grain, RemoteDependenciesResponse, RemoteSpawnChildRequest, RemoteSpawnRequest

• string id = 1

  Specifies the dependency ID

• string type_name = 2

  Specifies the dependency type name

• bytes bytea = 3

  The serialized binary data representing the Dependency's value.

• Code code = 1

• string message = 2

• string stack_trace = 3

• optional google.protobuf.Any details = 4

EscalateDirective defines the supervisor escalation directive It escalates the failure to the next parent in the hierarchy, thereby failing itself

(message has no fields)

FlagData is the serialized state of a Flag.

Used in: CRDTData

• bool enabled = 1

  Specifies whether the flag is enabled.

GCounterData is the serialized state of a GCounter.

Used in: CRDTData, PNCounterData

• map<string, uint64> state = 1

  Specifies the per-node counter slots.

• string node_address = 1

  Specifies the node address

• repeated string kinds = 1

  Specifies the list of kinds

• string node_address = 1

  Specifies the node address

• string node_address = 1

  Specifies the node address

• uint64 load = 2

  Specifies the total number of actors and grains for the given node

• string peer_address = 1

  Specifies the peer address

GetReliableCompanionRequest resolves the live reliable-delivery controller companion of an endpoint hosted on the serving node. The serving node runs the same local-tree resolution and ownership validation it applies to its own flows, so only a validated live endpoint-companion pair is returned. Remoting-only flows use this request to find their explicitly addressed peer without a cluster registry.

• string host = 1

  Specifies the remote host address of the serving node

• int32 port = 2

  Specifies the remote port of the serving node

• string endpoint_name = 3

  Specifies the user-visible name of the endpoint owning the companion

• ReliableControllerRole role = 4

  Specifies the controller role to resolve for the endpoint

• string address = 1

  Specifies the validated companion address

Grain represents the virtual actor information on the wire.

Used in: PeerState, PersistPeerGrain, RelocateBatchRequest, RemoteActivateGrainRequest, RemoteAskGrainRequest, RemoteTellGrainRequest

• optional GrainId grain_id = 1

• string host = 2

• int32 port = 3

• repeated Dependency dependencies = 4

• optional google.protobuf.Duration activation_timeout = 5

• int32 activation_retries = 6

• optional int64 mailbox_capacity = 7

• bool disable_relocation = 8

• bool eager_relocation = 9

  eager_relocation opts the grain into upfront reactivation on another node when its host departs the cluster. When false (default) the grain relocates lazily: its directory entry is cleaned and it re-activates on next use.

• optional ReentrancyConfig reentrancy = 10

  reentrancy carries the grain's async request policy so that eager relocation and remote activation reconstruct it. Absent when the grain has no policy.

Used in: Grain, RemovePeerGrain

• string kind = 1

• string name = 2

• string value = 3

Hello is the payload of HELLO and HELLO_ACK frames on the duplex protocol. Effective limits are the pairwise minimum of the dialer and acceptor values.

• uint32 revision = 1

  Capability revision. Cumulative: 1 = baseline DATA/REPLY/ERROR/PING/PONG, 2 = chunking, 3 = compression tables, 4 = credit-based flow control.

• string system_name = 2

  Actor system name of the sending node.

• string host = 3

  Advertised host of the sending node.

• uint32 port = 4

  Advertised remoting port of the sending node.

• LaneRole lane_role = 5

  Role of this connection within the peer lane set.

• uint32 lane_index = 6

  Index within the role (meaningful for ordinary lanes).

• CompressionCodec compression = 7

  Proposed (dialer) or selected (acceptor) compression codec.

• uint32 max_frame_size = 8

  Largest frame payload the sender is willing to accept.

• uint64 max_message_size = 9

  Largest reassembled message the sender is willing to accept.

• uint64 initial_credits = 10

  Initial credit window in bytes proposed by the sender.

• uint32 max_concurrent_large_transfers = 11

  Maximum concurrent chunk reassembly groups the sender will hold.

LWWRegisterData is the serialized state of a LWWRegister.

Used in: CRDTData

• bytes value = 1

  Specifies the serialized value as raw bytes.

• int64 timestamp_nanos = 2

  Specifies the write timestamp in nanoseconds since epoch.

• string node_id = 3

  Specifies the node that last wrote this value.

LaneRole identifies the role of a duplex connection within the per-peer lane set negotiated at HELLO time.

Used in: Hello

• LANE_ROLE_CONTROL = 0

• LANE_ROLE_ORDINARY = 1

• LANE_ROLE_LARGE = 2

LongLivedPassivation represents a strategy where the actor is long-lived and should never be passivated automatically. This is suitable for actors that are critical system components or serve high-throughput workloads with consistent usage patterns.

Used in: PassivationStrategy

(message has no fields)

MVRegisterData is the serialized state of an MVRegister.

Used in: CRDTData

• repeated MVRegisterData.MVRegisterEntry entries = 1

  Specifies the register entries (one per concurrent value).

• map<string, uint64> clock = 2

  Specifies the per-node vector clock.

MVRegisterEntry is a single value with its causal dot.

Used in: MVRegisterData

• bytes value = 1

  Specifies the serialized value as raw bytes.

• string node_id = 2

  Specifies the node that wrote this value.

• uint64 counter = 3

  Specifies the monotonic counter for the write event.

MessagesCountBasedPassivation defines a strategy where an actor is passivated after processing a certain number of messages, regardless of time. max_messages: The maximum number of messages an actor is allowed to process before it is considered for passivation. This can be useful in cases where actors have expensive memory or lifecycle costs.

Used in: PassivationStrategy

• int64 max_messages = 1

Used in: RemoteMetricResponse

• int64 uptime = 1

• optional google.protobuf.Duration latest_processed_duration = 2

• uint64 children_count = 3

• uint64 deadletters_count = 4

• uint64 restart_count = 5

• uint64 processed_count = 6

• uint64 stash_size = 7

• uint64 failure_count = 8

• uint64 reinstate_count = 9

NatsMessage defines the NATs message used by the discovery provider

• string host = 1

  Specifies the host name of the client node

• int32 port = 2

  Specifies the port of the client node

• string name = 3

  Specifies the client name

• NatsMessageType message_type = 4

  Specifies the message type

NatsMessageType defines the NATs message type

Used in: NatsMessage

• NATS_MESSAGE_TYPE_REGISTER = 0

• NATS_MESSAGE_TYPE_DEREGISTER = 1

• NATS_MESSAGE_TYPE_REQUEST = 2

• NATS_MESSAGE_TYPE_RESPONSE = 3

ORMapData is the serialized state of an ORMap.

Used in: CRDTData

• repeated ORMapData.ORMapEntry entries = 1

  Specifies the map entries.

• optional ORSetData key_set = 2

  Specifies the OR-Set that manages the key set.

ORMapEntry is a single key-value pair in the map.

Used in: ORMapData

• bytes key = 1

  Specifies the serialized map key as raw bytes.

• optional CRDTData value = 2

  Specifies the CRDT value associated with this key.

ORSetData is the serialized state of an ORSet.

Used in: CRDTData, ORMapData

• repeated ORSetData.ORSetEntry entries = 1

  Specifies the set entries.

• map<string, uint64> clock = 2

  Specifies the per-node vector clock.

ORSetDot represents a single causal event.

Used in: ORSetEntry

• string node_id = 1

  Specifies the node that produced this dot.

• uint64 counter = 2

  Specifies the monotonic counter for the event.

ORSetEntry is an element with its associated causal dots.

Used in: ORSetData

• bytes element = 1

  Specifies the serialized element as raw bytes.

• repeated ORSetDot dots = 2

  Specifies the causal dots associated with this element.

PNCounterData is the serialized state of a PNCounter.

Used in: CRDTData

• optional GCounterData increments = 1

  Specifies the increment counter.

• optional GCounterData decrements = 2

  Specifies the decrement counter.

PassivationStrategy encapsulates all supported passivation strategies for actors. Exactly one of the strategies should be specified. strategy: - time_based: Uses time-based idle detection to trigger passivation. - messages_count_based: Uses message count threshold to trigger passivation. - long_lived: Disables automatic passivation entirely.

Used in: Actor, RemotePassivationStrategyResponse, RemoteSpawnChildRequest, RemoteSpawnRequest

• oneof strategy

  • TimeBasedPassivation time_based = 1

  • MessagesCountBasedPassivation messages_count_based = 2

  • LongLivedPassivation long_lived = 3

Used in: PersistPeerStateRequest, Rebalance

• string host = 1

  Specifies the peer host

• int32 remoting_port = 2

  Specifies the remoting port

• int32 peers_port = 3

  Specifies the remoting host

• map<string, Actor> actors = 4

  Specifies the list of actors actorName -> Actor

• map<string, Grain> grains = 5

  grainId -> Grain

• string host = 1

  Specifies the peer host

• int32 remoting_port = 2

  Specifies the remoting port

• int32 peers_port = 3

  Specifies the remoting host

• optional Actor actor = 4

  Specifies the actor

• string host = 1

  Specifies the peer host

• int32 remoting_port = 2

  Specifies the remoting port

• int32 peers_port = 3

  Specifies the remoting host

• optional Grain grain = 4

  Specifies the grain

• optional PeerState peer_state = 1

  Specifies the peer state

(message has no fields)

QueueRetryConfig defines retries for durable queue operations.

Used in: ReliableProducerConfig

• uint32 max_attempts = 1

  Specifies the maximum number of attempts for one queue operation.

• optional google.protobuf.Duration initial_backoff = 2

  Specifies the delay before the first retry.

• optional PeerState peer_state = 1

  Specifies the peer state

• string peer_address = 1

  Specifies the peer address

ReentrancyConfig captures the reentrancy settings for an actor.

Used in: Actor, Grain, RemoteSpawnChildRequest, RemoteSpawnRequest

• ReentrancyMode mode = 1

  mode defines the reentrancy behavior.

• uint32 max_in_flight = 2

  max_in_flight limits outstanding async requests. Zero means unlimited.

ReentrancyMode defines how an actor processes other messages while awaiting an async request response.

Used in: ReentrancyConfig

• REENTRANCY_MODE_OFF = 0

  REENTRANCY_MODE_OFF disables async request processing.

• REENTRANCY_MODE_ALLOW_ALL = 1

  REENTRANCY_MODE_ALLOW_ALL allows the actor to continue processing all messages.

• REENTRANCY_MODE_STASH_NON_REENTRANT = 2

  REENTRANCY_MODE_STASH_NON_REENTRANT stashes user messages until the response arrives.

RegisterConsumer asks a producer controller to establish a registration.

Used in: DeliveryEnvelope

• string nonce = 1

  Identifies this registration attempt.

RegistrationAck accepts the latest consumer registration attempt.

Used in: DeliveryEnvelope

• string session_id = 1

  Identifies the producer controller incarnation.

• int64 next_seq = 2

  Specifies the first sequence the consumer should expect.

• string nonce = 3

  Echoes the registration attempt being accepted.

ReliableCompanionSpec marks an actor record as the endpoint-owned reliable-delivery controller of one endpoint incarnation and carries the ownership fields that cluster resolution validates.

Used in: Actor

• ReliableControllerRole role = 1

  Identifies which controller role the companion runs.

• string endpoint_name = 2

  Names the user-visible endpoint that owns the companion.

• string endpoint_incarnation_id = 3

  Pins the companion to one endpoint incarnation.

ReliableConsumerConfig defines consumer-side delivery settings.

Used in: ReliableDeliveryConfig

• string producer_name = 1

  Names the producer endpoint whose messages are accepted.

• uint32 flow_control_window = 2

  Specifies the maximum demand granted in one request.

• optional google.protobuf.Duration resend_interval = 3

  Defines how often registration, demand, and delivery are retried.

ReliableControllerRole identifies which reliable-delivery controller a companion actor runs for its endpoint.

Used in: GetReliableCompanionRequest, ReliableCompanionSpec

• RELIABLE_CONTROLLER_ROLE_UNSPECIFIED = 0

  The role is not set; records carrying it never validate.

• RELIABLE_CONTROLLER_ROLE_PRODUCER = 1

  The companion is a producer controller.

• RELIABLE_CONTROLLER_ROLE_CONSUMER = 2

  The companion is a consumer controller.

ReliableDeliveryConfig defines one endpoint's reliable-delivery settings.

Used in: Actor, RemoteSpawnRequest

• oneof endpoint

  • ReliableProducerConfig producer = 1

    Configures a producer endpoint and its controller.

  • ReliableConsumerConfig consumer = 2

    Configures a consumer endpoint and its controller.

ReliableDeliveryPattern selects the producer-side delivery pattern.

Used in: ReliableProducerConfig

• RELIABLE_DELIVERY_PATTERN_UNSPECIFIED = 0

  The pattern is not set; decoded as point-to-point for compatibility with records written before the field existed.

• RELIABLE_DELIVERY_PATTERN_POINT_TO_POINT = 1

  One producer endpoint feeds exactly one named consumer endpoint.

• RELIABLE_DELIVERY_PATTERN_WORK_PULLING = 2

  One producer endpoint distributes work across dynamically registered workers that each run a consumer controller.

ReliablePayload carries a self-describing serialized application message.

Used in: SequencedMessage

• bytes data = 1

  Contains the serializer's self-describing message frame.

ReliableProducerConfig defines producer-side delivery settings.

Used in: ReliableDeliveryConfig

• string consumer_name = 1

  Names the consumer endpoint authorized to receive messages. Empty when pattern is work-pulling: workers are discovered by registration.

• optional string durable_queue_id = 2

  Identifies the durable queue in the endpoint's user dependencies.

• optional QueueRetryConfig queue_retry = 3

  Defines retries for durable queue operations.

• optional google.protobuf.Duration local_retry_interval = 4

  Defines how often unacknowledged local protocol messages are retried.

• bool delivery_confirmation = 5

  Enables DeliveryConfirmed notifications toward the producer endpoint.

• uint32 max_chunk_bytes = 6

  Splits payloads larger than this many bytes into sequenced chunks; zero disables chunking.

• ReliableDeliveryPattern pattern = 7

  Selects point-to-point or work-pulling on the producer side. Unspecified is treated as point-to-point.

RelocateBatchRequest carries one target peer's share of a departed node's actors and grains, relocated in a single round trip.

• string departed_node = 1

  Specifies the remoting address (host:remoting_port) of the node that left the cluster. The target uses it to clean up stale registry entries that still point at the departed node before recreating the relocated actors and grains.

• repeated Actor actors = 2

  Specifies the actors to recreate on the target node

• repeated Grain grains = 3

  Specifies the grains to relocate on the target node. The target dispatches on each grain's eager_relocation flag: eager grains are reactivated upfront, lazy grains (the default) only have their directory entry released so they re-activate on next use.

RelocateBatchResponse reports per-item relocation failures. An empty list means the whole batch was relocated successfully.

• repeated RelocationFailure failures = 1

  Specifies the items that could not be relocated

RelocationFailure describes a single actor or grain that could not be relocated as part of a RelocateBatchRequest.

Used in: RelocateBatchResponse

• string id = 1

  Specifies the actor address or the grain identity string

• bool grain = 2

  Specifies whether the failed item is a grain

• string message = 3

  Specifies the failure reason

• optional Grain grain = 1

(message has no fields)

• optional Grain grain = 1

• bytes message = 2

• optional google.protobuf.Duration request_timeout = 3

• bytes message = 1

RemoteAsk is used to send a message to an actor remotely and expect a response immediately.

• repeated RemoteMessage remote_messages = 1

  Specifies the remote message to send

• optional google.protobuf.Duration timeout = 2

  Specifies the timeout(how long to wait for a reply)

• repeated bytes messages = 1

  Specifies the message to send to the actor Any proto message is allowed to be sent

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

• repeated string addresses = 1

  Specifies the children

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

• repeated Dependency dependencies = 1

  Specifies the dependencies

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

• string kind = 1

  Specifies the kind

RemoteLookupRequest checks whether a given actor exists on a remote host

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

• string address = 1

  Specifies the actor address

RemoteMessage will be used by Actors to communicate remotely

Used in: RemoteAskRequest, RemoteTellRequest

• string sender = 1

  Specifies the sender' address

• string receiver = 2

  Specifies the actor address

• bytes message = 3

  Specifies the message to send to the actor Any proto message is allowed to be sent

• map<string, string> metadata = 4

  Per-message propagation metadata (trace headers, baggage, auth, etc.). When set, the server applies it via the configured ContextPropagator in preference to the request-level metadata. This enables coalesced batches that carry distinct per-call context for every message. Left empty by the synchronous RemoteTell path, which still propagates at the request level.

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

• optional Metric metric = 1

  Specifies the metric

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

• string address = 1

  Specifies the parent

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

• optional PassivationStrategy passivation_strategy = 1

  Specifies the passivation strategy

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

• string address = 1

  Specifies the actor address

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

(message has no fields)

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

• string role = 1

  Specifies the role

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string actor_name = 3

  Specifies the actor name.

• string actor_type = 4

  Specifies the actor type

• bool relocatable = 5

  Specifies if the actor is relocatable

• optional PassivationStrategy passivation_strategy = 6

  Specifies the passivation strategy

• repeated Dependency dependencies = 7

  Specifies the dependencies

• bool enable_stash = 8

  States whether the actor will require a stash buffer

• optional ReentrancyConfig reentrancy = 9

  Specifies the reentrancy configuration when explicitly set

• string parent = 10

  Specifies the parent actor name

• optional SupervisorSpec supervisor = 11

  Specifies the supervisor configuration when explicitly set

• optional google.protobuf.Duration init_timeout = 12

  Specifies the init timeout override when explicitly set. When unset, the hosting node's system-wide init timeout is used.

• string address = 1

  Specifies the actor address

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string actor_name = 3

  Specifies the actor name.

• string actor_type = 4

  Specifies the actor type

• optional SingletonSpec singleton = 5

  Specifies if the actor is a singleton

• bool relocatable = 6

  Specifies if the actor is relocatable

• optional PassivationStrategy passivation_strategy = 7

  Specifies the passivation strategy

• repeated Dependency dependencies = 8

  Specifies the dependencies

• bool enable_stash = 9

  States whether the actor will require a stash buffer

• optional string role = 10

  Specifies the role the actor belongs to

• optional SupervisorSpec supervisor = 11

  Specifies the supervisor configuration when explicitly set

• optional ReentrancyConfig reentrancy = 12

  Specifies the reentrancy configuration when explicitly set

• optional google.protobuf.Duration init_timeout = 13

  Specifies the init timeout override when explicitly set. When unset, the hosting node's system-wide init timeout is used.

• optional ReliableDeliveryConfig reliable_delivery = 14

  Specifies the reliable-delivery endpoint settings when the actor is spawned as a reliable producer or consumer endpoint. The hosting node restores them as spawn options so remote placement behaves exactly like a local spawn, including controller companion creation.

• string address = 1

  Specifies the actor address

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

• uint64 size = 1

  Specifies the stash size

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

• State state = 4

  Specifies the state to check

• bool state = 1

  Specifies whether the state is true or false

• string host = 1

  Specifies the remote host address

• int32 port = 2

  Specifies the remote port

• string name = 3

  Specifies the actor name

(message has no fields)

• optional Grain grain = 1

• bytes message = 2

(message has no fields)

RemoteTell is used to send a message to an actor remotely

• repeated RemoteMessage remote_messages = 1

  Specifies the remote message to send

(message has no fields)

RemoteUnWatchRequest cancels a previously registered remote watch.

• string host = 1

  Specifies the remote host address of the watchee

• int32 port = 2

  Specifies the remote port of the watchee

• string name = 3

  Specifies the watchee actor name

• string watcher_address = 4

  Specifies the full address of the watcher that previously watched the actor

(message has no fields)

RemoteWatchRequest registers a remote watcher for an actor on this node.

• string host = 1

  Specifies the remote host address of the watchee

• int32 port = 2

  Specifies the remote port of the watchee

• string name = 3

  Specifies the watchee actor name

• string watcher_address = 4

  Specifies the full address of the watcher to notify on termination

(message has no fields)

• string peer_address = 1

  Specifies the peer address

• string actor_name = 2

  Specifies the remoting por Specifies the actor name

• string peer_address = 1

  Specifies the peer address

• optional GrainId grain_id = 2

ReplyKind identifies the type of process awaiting the response.

Used in: AsyncRequest

• REPLY_KIND_ACTOR = 0

  REPLY_KIND_ACTOR routes the response to an actor address.

• REPLY_KIND_GRAIN = 1

  REPLY_KIND_GRAIN routes the response to a grain identity.

• REPLY_KIND_CLIENT = 2

  REPLY_KIND_CLIENT completes the pending ask registered on the receiving node. reply_to is empty for this kind.

Request grants demand and carries the latest confirmed sequence.

Used in: DeliveryEnvelope

• string session_id = 1

  Identifies the producer controller incarnation.

• string registration_nonce = 2

  Identifies the accepted consumer registration.

• int64 confirmed_seq = 3

  Specifies the highest sequence processed by the consumer.

• int64 request_up_to_seq = 4

  Specifies the highest sequence the producer may send.

• bool via_timeout = 5

  Indicates that the request should also resend unconfirmed messages.

RestartDirective defines supervisor restart directive

• uint32 max_retries = 1

  Specifies the maximum number of retries; When reaching this number, the faulty actor is stopped

• int64 timeout = 2

  Specifies the time range to restart the faulty actor

ResumeDirective defines the supervisor resume directive This ignores the failure and processes the next message, instead

(message has no fields)

SequencedMessage carries one serialized application message in stream order.

Used in: DeliveryEnvelope

• string session_id = 1

  Identifies the producer controller incarnation.

• string message_id = 2

  Identifies the application message across retries and sessions.

• int64 seq = 3

  Specifies the message's ordered position in the stream.

• optional ReliablePayload payload = 4

  Contains the immutable serialized application message, or one chunk of it.

• optional ChunkInfo chunk_info = 5

  Marks the payload as one chunk of a chunked message when present.

Used in: Actor, RemoteSpawnRequest

• optional google.protobuf.Duration spawn_timeout = 1

  Specifies the spawn timeout for the singleton actor

• optional google.protobuf.Duration wait_interval = 2

  Specifies the wait interval between spawn retries

• int32 max_retries = 3

  Specifies the maximum number of spawn retries

Used in: RemoteStateRequest

• STATE_UNKNOWN = 0

• STATE_RUNNING = 1

• STATE_SUSPENDED = 2

• STATE_STOPPING = 3

• STATE_RELOCATABLE = 4

• STATE_SINGLETON = 5

StopDirective defines the supervisor stop directive

(message has no fields)

• STRATEGY_ONE_FOR_ONE = 0

• STRATEGY_ONE_FOR_ALL = 1

SupervisorDirective defines the action to apply when an actor fails.

Used in: SupervisorDirectiveRule, SupervisorSpec

• SUPERVISOR_DIRECTIVE_STOP = 0

• SUPERVISOR_DIRECTIVE_RESUME = 1

• SUPERVISOR_DIRECTIVE_RESTART = 2

• SUPERVISOR_DIRECTIVE_ESCALATE = 3

SupervisorDirectiveRule binds an error type to a directive.

Used in: SupervisorSpec

• string error_type = 1

  Fully-qualified Go error type name (reflect.Type.String()).

• SupervisorDirective directive = 2

  Specifies the directive to apply.

SupervisorSpec defines an explicit supervisor configuration for an actor.

Used in: Actor, RemoteSpawnChildRequest, RemoteSpawnRequest

• SupervisorStrategy strategy = 1

  Specifies the supervisor strategy.

• uint32 max_retries = 2

  Specifies the maximum number of retries.

• optional google.protobuf.Duration timeout = 3

  Specifies the restart timeout window.

• repeated SupervisorDirectiveRule directives = 4

  Specifies error-type specific directives.

• optional SupervisorDirective any_error_directive = 5

  Specifies the directive to apply for any error.

SupervisorStrategy defines how directives apply across failing actors.

Used in: SupervisorSpec

• SUPERVISOR_STRATEGY_ONE_FOR_ONE = 0

• SUPERVISOR_STRATEGY_ONE_FOR_ALL = 1

TimeBasedPassivation defines a strategy where an actor is passivated after a specified period of inactivity. passivate_after: The duration after which an idle actor should be stopped. This helps free up system resources by removing actors that haven't received messages for a defined time window.

Used in: PassivationStrategy

• optional google.protobuf.Duration passivate_after = 1

• string id = 1

  Specifies the message unique id

• string topic = 2

  Specifies the topic

• bytes message = 3

  Specifies the message

TopicStatsRequest asks a peer TopicActor for its local subscriber count for a given topic. Peers answer with their local view only; they do not fan the request out any further.

• string topic = 1

  Specifies the topic to inspect

TopicStatsResponse returns a peer TopicActor's local subscriber count for the topic named in the matching TopicStatsRequest.

• int32 local_subscriber_count = 1

  Specifies the number of subscribers registered locally for the topic