Documentation
Preparing search index...
@rivetkit/engine-runner-protocol
Module @rivetkit/engine-runner-protocol
Enumerations
StopCode
Type Aliases
ActorConfig
ActorIntent
ActorIntentSleep
ActorIntentStop
ActorName
ActorState
ActorStateRunning
ActorStateStopped
Command
CommandStartActor
CommandStopActor
CommandWrapper
Event
EventActorIntent
EventActorSetAlarm
EventActorStateUpdate
EventWrapper
i64
Id
Json
KvDeleteRequest
KvDeleteResponse
KvDropRequest
KvDropResponse
KvErrorResponse
KvGetRequest
KvGetResponse
KvKey
KvListAllQuery
KvListPrefixQuery
KvListQuery
KvListRangeQuery
KvListRequest
KvListResponse
KvMetadata
KvPutRequest
KvPutResponse
KvRequestData
KvResponseData
KvValue
MessageId
ProtocolMetadata
RequestId
ToClient
ToClientAckEvents
ToClientClose
ToClientCommands
ToClientInit
ToClientKvResponse
ToClientRequestAbort
ToClientRequestChunk
ToClientRequestStart
ToClientTunnelMessage
ToClientTunnelMessageKind
ToClientWebSocketClose
ToClientWebSocketMessage
ToClientWebSocketOpen
ToGateway
ToServer
ToServerAckCommands
ToServerEvents
ToServerInit
ToServerKvRequest
ToServerlessServer
ToServerlessServerInit
ToServerPing
ToServerResponseAbort
ToServerResponseChunk
ToServerResponseStart
ToServerStopping
ToServerTunnelMessage
ToServerTunnelMessageKind
ToServerWebSocketClose
ToServerWebSocketMessage
ToServerWebSocketMessageAck
ToServerWebSocketOpen
TunnelAck
u16
u32
u64
Functions
decodeToClient
decodeToGateway
decodeToServer
decodeToServerlessServer
encodeToClient
encodeToGateway
encodeToServer
encodeToServerlessServer
readActorConfig
readActorIntent
readActorName
readActorState
readActorStateStopped
readCommand
readCommandStartActor
readCommandStopActor
readCommandWrapper
readEvent
readEventActorIntent
readEventActorSetAlarm
readEventActorStateUpdate
readEventWrapper
readId
readJson
readKvDeleteRequest
readKvErrorResponse
readKvGetRequest
readKvGetResponse
readKvKey
readKvListPrefixQuery
readKvListQuery
readKvListRangeQuery
readKvListRequest
readKvListResponse
readKvMetadata
readKvPutRequest
readKvRequestData
readKvResponseData
readKvValue
readMessageId
readProtocolMetadata
readRequestId
readStopCode
readToClient
readToClientAckEvents
readToClientCommands
readToClientInit
readToClientKvResponse
readToClientRequestChunk
readToClientRequestStart
readToClientTunnelMessage
readToClientTunnelMessageKind
readToClientWebSocketClose
readToClientWebSocketMessage
readToClientWebSocketOpen
readToGateway
readToServer
readToServerAckCommands
readToServerEvents
readToServerInit
readToServerKvRequest
readToServerlessServer
readToServerlessServerInit
readToServerPing
readToServerResponseChunk
readToServerResponseStart
readToServerTunnelMessage
readToServerTunnelMessageKind
readToServerWebSocketClose
readToServerWebSocketMessage
readToServerWebSocketMessageAck
readToServerWebSocketOpen
writeActorConfig
writeActorIntent
writeActorName
writeActorState
writeActorStateStopped
writeCommand
writeCommandStartActor
writeCommandStopActor
writeCommandWrapper
writeEvent
writeEventActorIntent
writeEventActorSetAlarm
writeEventActorStateUpdate
writeEventWrapper
writeId
writeJson
writeKvDeleteRequest
writeKvErrorResponse
writeKvGetRequest
writeKvGetResponse
writeKvKey
writeKvListPrefixQuery
writeKvListQuery
writeKvListRangeQuery
writeKvListRequest
writeKvListResponse
writeKvMetadata
writeKvPutRequest
writeKvRequestData
writeKvResponseData
writeKvValue
writeMessageId
writeProtocolMetadata
writeRequestId
writeStopCode
writeToClient
writeToClientAckEvents
writeToClientCommands
writeToClientInit
writeToClientKvResponse
writeToClientRequestChunk
writeToClientRequestStart
writeToClientTunnelMessage
writeToClientTunnelMessageKind
writeToClientWebSocketClose
writeToClientWebSocketMessage
writeToClientWebSocketOpen
writeToGateway
writeToServer
writeToServerAckCommands
writeToServerEvents
writeToServerInit
writeToServerKvRequest
writeToServerlessServer
writeToServerlessServerInit
writeToServerPing
writeToServerResponseChunk
writeToServerResponseStart
writeToServerTunnelMessage
writeToServerTunnelMessageKind
writeToServerWebSocketClose
writeToServerWebSocketMessage
writeToServerWebSocketMessageAck
writeToServerWebSocketOpen
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Enumerations
Stop
Code
Type Aliases
Actor
Config
Actor
Intent
Actor
Intent
Sleep
Actor
Intent
Stop
Actor
Name
Actor
State
Actor
State
Running
Actor
State
Stopped
Command
Command
Start
Actor
Command
Stop
Actor
Command
Wrapper
Event
Event
Actor
Intent
Event
Actor
Set
Alarm
Event
Actor
State
Update
Event
Wrapper
i64
Id
Json
Kv
Delete
Request
Kv
Delete
Response
Kv
Drop
Request
Kv
Drop
Response
Kv
Error
Response
Kv
Get
Request
Kv
Get
Response
Kv
Key
Kv
List
All
Query
Kv
List
Prefix
Query
Kv
List
Query
Kv
List
Range
Query
Kv
List
Request
Kv
List
Response
Kv
Metadata
Kv
Put
Request
Kv
Put
Response
Kv
Request
Data
Kv
Response
Data
Kv
Value
Message
Id
Protocol
Metadata
Request
Id
To
Client
To
Client
Ack
Events
To
Client
Close
To
Client
Commands
To
Client
Init
To
Client
Kv
Response
To
Client
Request
Abort
To
Client
Request
Chunk
To
Client
Request
Start
To
Client
Tunnel
Message
To
Client
Tunnel
Message
Kind
To
Client
Web
Socket
Close
To
Client
Web
Socket
Message
To
Client
Web
Socket
Open
To
Gateway
To
Server
To
Server
Ack
Commands
To
Server
Events
To
Server
Init
To
Server
Kv
Request
To
Serverless
Server
To
Serverless
Server
Init
To
Server
Ping
To
Server
Response
Abort
To
Server
Response
Chunk
To
Server
Response
Start
To
Server
Stopping
To
Server
Tunnel
Message
To
Server
Tunnel
Message
Kind
To
Server
Web
Socket
Close
To
Server
Web
Socket
Message
To
Server
Web
Socket
Message
Ack
To
Server
Web
Socket
Open
Tunnel
Ack
u16
u32
u64
Functions
decode
To
Client
decode
To
Gateway
decode
To
Server
decode
To
Serverless
Server
encode
To
Client
encode
To
Gateway
encode
To
Server
encode
To
Serverless
Server
read
Actor
Config
read
Actor
Intent
read
Actor
Name
read
Actor
State
read
Actor
State
Stopped
read
Command
read
Command
Start
Actor
read
Command
Stop
Actor
read
Command
Wrapper
read
Event
read
Event
Actor
Intent
read
Event
Actor
Set
Alarm
read
Event
Actor
State
Update
read
Event
Wrapper
read
Id
read
Json
read
Kv
Delete
Request
read
Kv
Error
Response
read
Kv
Get
Request
read
Kv
Get
Response
read
Kv
Key
read
Kv
List
Prefix
Query
read
Kv
List
Query
read
Kv
List
Range
Query
read
Kv
List
Request
read
Kv
List
Response
read
Kv
Metadata
read
Kv
Put
Request
read
Kv
Request
Data
read
Kv
Response
Data
read
Kv
Value
read
Message
Id
read
Protocol
Metadata
read
Request
Id
read
Stop
Code
read
To
Client
read
To
Client
Ack
Events
read
To
Client
Commands
read
To
Client
Init
read
To
Client
Kv
Response
read
To
Client
Request
Chunk
read
To
Client
Request
Start
read
To
Client
Tunnel
Message
read
To
Client
Tunnel
Message
Kind
read
To
Client
Web
Socket
Close
read
To
Client
Web
Socket
Message
read
To
Client
Web
Socket
Open
read
To
Gateway
read
To
Server
read
To
Server
Ack
Commands
read
To
Server
Events
read
To
Server
Init
read
To
Server
Kv
Request
read
To
Serverless
Server
read
To
Serverless
Server
Init
read
To
Server
Ping
read
To
Server
Response
Chunk
read
To
Server
Response
Start
read
To
Server
Tunnel
Message
read
To
Server
Tunnel
Message
Kind
read
To
Server
Web
Socket
Close
read
To
Server
Web
Socket
Message
read
To
Server
Web
Socket
Message
Ack
read
To
Server
Web
Socket
Open
write
Actor
Config
write
Actor
Intent
write
Actor
Name
write
Actor
State
write
Actor
State
Stopped
write
Command
write
Command
Start
Actor
write
Command
Stop
Actor
write
Command
Wrapper
write
Event
write
Event
Actor
Intent
write
Event
Actor
Set
Alarm
write
Event
Actor
State
Update
write
Event
Wrapper
write
Id
write
Json
write
Kv
Delete
Request
write
Kv
Error
Response
write
Kv
Get
Request
write
Kv
Get
Response
write
Kv
Key
write
Kv
List
Prefix
Query
write
Kv
List
Query
write
Kv
List
Range
Query
write
Kv
List
Request
write
Kv
List
Response
write
Kv
Metadata
write
Kv
Put
Request
write
Kv
Request
Data
write
Kv
Response
Data
write
Kv
Value
write
Message
Id
write
Protocol
Metadata
write
Request
Id
write
Stop
Code
write
To
Client
write
To
Client
Ack
Events
write
To
Client
Commands
write
To
Client
Init
write
To
Client
Kv
Response
write
To
Client
Request
Chunk
write
To
Client
Request
Start
write
To
Client
Tunnel
Message
write
To
Client
Tunnel
Message
Kind
write
To
Client
Web
Socket
Close
write
To
Client
Web
Socket
Message
write
To
Client
Web
Socket
Open
write
To
Gateway
write
To
Server
write
To
Server
Ack
Commands
write
To
Server
Events
write
To
Server
Init
write
To
Server
Kv
Request
write
To
Serverless
Server
write
To
Serverless
Server
Init
write
To
Server
Ping
write
To
Server
Response
Chunk
write
To
Server
Response
Start
write
To
Server
Tunnel
Message
write
To
Server
Tunnel
Message
Kind
write
To
Server
Web
Socket
Close
write
To
Server
Web
Socket
Message
write
To
Server
Web
Socket
Message
Ack
write
To
Server
Web
Socket
Open
Documentation
Loading...