package internalpb

Get desktop application:
View/edit binary Protocol Buffers messages

ClusterService is used to interact with the cluster internal

• rpc GetNodeMetric (GetNodeMetricRequest, GetNodeMetricResponse)

  cluster.proto:12

  GetNodeMetric returns the node metric

  message GetNodeMetricRequest

  cluster.proto:17

  • string node_address = 1

    Specifies the node address

  message GetNodeMetricResponse

  cluster.proto:22

  • string node_remote_address = 1

    Specifies the node address

  • uint64 actors_count = 2

    Specifies the actors count for the given node

• rpc GetKinds (GetKindsRequest, GetKindsResponse)

  cluster.proto:14

  GetKinds returns the list of cluster kinds

  message GetKindsRequest

  cluster.proto:29

  • string node_address = 1

    Specifies the node address

  message GetKindsResponse

  cluster.proto:34

  • repeated string kinds = 1

    Specifies the list of kinds

RemotingService defines the remoting service With remoting one can: - send messages to actors - lookup actor remotely - spawn actor remotely - re-spawn actor remotely - stop actor remotely

• rpc RemoteAsk (RemoteAskRequest, RemoteAskResponse)

  remoting.proto:21

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

  message RemoteAskRequest

  remoting.proto:37

  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)

  message RemoteAskResponse

  remoting.proto:44

  • repeated google.protobuf.Any messages = 1

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

• rpc RemoteTell (RemoteTellRequest, RemoteTellResponse)

  remoting.proto:24

  RemoteTell is used to send a message to a remote actor The actor on the other line can reply to the sender by using the Sender in the message

  message RemoteTellRequest

  remoting.proto:51

  RemoteTell is used to send a message to an actor remotely

  • repeated RemoteMessage remote_messages = 1

    Specifies the remote message to send

  message RemoteTellResponse

  remoting.proto:56

  (message has no fields)

• rpc RemoteLookup (RemoteLookupRequest, RemoteLookupResponse)

  remoting.proto:26

  Lookup for an actor on a remote host.

  message RemoteLookupRequest

  remoting.proto:59

  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

  message RemoteLookupResponse

  remoting.proto:68

  • optional goaktpb.Address address = 1

    Specifies the actor address

• rpc RemoteReSpawn (RemoteReSpawnRequest, RemoteReSpawnResponse)

  remoting.proto:28

  RemoteReSpawn restarts an actor on a remote machine

  message RemoteReSpawnRequest

  remoting.proto:84

  • string host = 1

    Specifies the remote host address

  • int32 port = 2

    Specifies the remote port

  • string name = 3

    Specifies the actor name

  message RemoteReSpawnResponse

  remoting.proto:93

  (message has no fields)

• rpc RemoteStop (RemoteStopRequest, RemoteStopResponse)

  remoting.proto:30

  RemoteStop stops an actor on a remote machine

  message RemoteStopRequest

  remoting.proto:95

  • string host = 1

    Specifies the remote host address

  • int32 port = 2

    Specifies the remote port

  • string name = 3

    Specifies the actor name

  message RemoteStopResponse

  remoting.proto:104

  (message has no fields)

• rpc RemoteSpawn (RemoteSpawnRequest, RemoteSpawnResponse)

  remoting.proto:32

  RemoteSpawn starts an actor on a remote machine

  message RemoteSpawnRequest

  remoting.proto:106

  • 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 is_singleton = 5

    Specifies if the actor is a singleton

  • bool relocatable = 6

    Specifies if the actor is relocatable

  • optional google.protobuf.Duration passivate_after = 7

    Specifies the passivation time

  • repeated Dependency dependencies = 8

    Specifies the dependencies

  • bool enable_stash = 9

    States whether the actor will require a stash buffer

  message RemoteSpawnResponse

  remoting.proto:127

  (message has no fields)

ActorProps defines the properties of an actor that can be used to spawn an actor remotely.

Used in: PeerState

• string actor_name = 1

  Specifies the actor name.

• string actor_type = 2

  Specifies the actor type

• bool is_singleton = 3

  Specifies if the actor is a singleton

• bool relocatable = 4

  Specifies if the actor is disabled for relocation

• optional google.protobuf.Duration passivate_after = 5

  Specifies the passivation time

• repeated Dependency dependencies = 6

  Specifies the dependencies

• bool enable_stash = 7

  States whether the actor will require a stash buffer

ActorRef represents the actor information on the wire.

• optional goaktpb.Address actor_address = 1

  Specifies the actor address

• string actor_type = 2

  Specifies the actor type

• bool is_singleton = 3

  Specifies if the actor is a singleton

• bool relocatable = 4

  Specifies if the actor is disabled for relocation

• optional google.protobuf.Duration passivate_after = 5

  Specifies the passivation time

• repeated Dependency dependencies = 6

  Specifies the dependencies

• bool enable_stash = 7

  States whether the actor will require a stash buffer

• int64 total_count = 1

  Specifies the total count

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: ActorProps, ActorRef, 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.

• string id = 1

  Specifies the message unique id

• string topic = 2

  Specifies the topic

• optional google.protobuf.Any message = 3

  Specifies the message

• optional goaktpb.Deadletter deadletter = 1

  Specifies the deadletter to emit

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

Used in: HandleFault

(message has no fields)

(message has no fields)

• optional string actor_id = 1

  optional for a specific actor

HandleFault message is sent by a child actor to its parent when it is panicking or returning an error while processing message

• string actor_id = 1

  Specifies the actor id

• string message = 2

  Specifies the message

• oneof directive

  Specifies the directive

  • StopDirective stop = 3

  • ResumeDirective resume = 4

  • RestartDirective restart = 5

  • EscalateDirective escalate = 6

• Strategy strategy = 7

  Specifies the strategy

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

Used in: 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, ActorProps> actors = 4

  Specifies the list of actors actorName -> ActorProps

• optional PeerState peer_state = 1

  Specifies the peer state

• string peer_address = 1

  Specifies the peer address

RemoteMessage will be used by Actors to communicate remotely

Used in: RemoteAskRequest, RemoteTellRequest

• optional goaktpb.Address sender = 1

  Specifies the sender' address

• optional goaktpb.Address receiver = 2

  Specifies the actor address

• optional google.protobuf.Any message = 3

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

RestartDirective defines supervisor restart directive

Used in: HandleFault

• 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 process the next message, instead

Used in: HandleFault

(message has no fields)

(message has no fields)

StopDirective defines the supervisor stop directive

Used in: HandleFault

(message has no fields)

Used in: HandleFault

• STRATEGY_ONE_FOR_ONE = 0

• STRATEGY_ONE_FOR_ALL = 1