Module behavior_controller_v0

Source

Structs§

AspectAddr
An aspect’s address, comprising of an aspect guid and an actor id
AspectUpsert
A command used for aspect_upsert to issue an aspect insertion/update that needs to be synced with the host
BehaviorModuleId
Identifier for a specific version of a module.
BehaviorModuleRegistration
Contains all registration info for an external behavior module
BehaviorRegistration
Describes a behavior in an external behavior module
BehaviorTypeId
Represents a unique behavior type in an external behavior module
IncomingMessage
A message to be sent to a specific behavior instance for processing
OutgoingMessage
An outgoing message that is being sent from a behavior instance to the controller module
OutgoingMessageAddr
An outgoing message’s address, targeting either an entire actor or a specific behavior

Constants§

CONTROLLER_SENTINEL_ACTOR_ID
Sentinel value indicating that a message is a system message, with open interpretation of what this entails, by the behavior module.
INCOMING_MESSAGE_NO_INSTANCE_SENTINEL
Sentinel value indicating that a system message has no instance tied to it.
INVALID_GUID_COMPONENT

Statics§

API
FFI API

Functions§

aspect_remove
Requests to remove aspect data associated to a single actor in a store. If the aspect store doesn’t exist, nothing happens
aspect_reset_all
Reset all existing aspect stores to their initial states
aspect_upsert
Requests multiple insertions or updates in aspect stores; if an aspect doesn’t exist, it’s seamlessly created on the host
instance_clone
Clone a behavior instance to create a new identical instance
instance_create
Create a behavior instance of the specific type
instance_destroy
Destroy a behavior instance
instance_persist
Persist a behavior instance by serializing it to a blob
instance_restore
Restore a behavior instance by deserializing it from a persistent representation
instances_handle_messages
Have the specified instances process the provided messages
list_modules
Returns a serialized JSON vector of bytes with a list of external registration info.
load_behavior_module
Loads the module with the given ID.
publish
Publishes the module with the given ID and returns a possibly different ID of the published version.

Type Aliases§

ActorId
BehaviorInstanceId
A globally unique id representing a behavior instance that lives somewhere in an active behavior module
BehaviorTypeIdInner
A globally unique id representing a behavior type
Guid