RPC
View as MarkdownThis page lists the Go SDK names for RPCs. The doc comment of each API gives its parameters, defaults, and errors. Read them in the Go SDK API reference.
API names
| Task | Go API | Dex behavior |
|---|---|---|
| Define an RPC handler | DefineRPC with a bound Flow method, returned from GetRPCs | Flow definition |
| Set the durable RPC name | Name of RPCOptions. It defaults to the Go method name. | Flow definition |
| Set the RPC timeout | Timeout of RPCOptions | RPC timeout |
| Lock Attributes for the whole call | LockAttributes of RPCOptions | Locks |
| Request transactional reads and writes without locks | IsTransactional of RPCOptions | Transactional RPCs |
| Load AttributeMap values and Channel messages | LoadAttributeMaps, LoadAttributeMapInstances, LoadChannels, LoadChannelMaps, and LoadChannelMapInstances of RPCOptions | Selective state loading |
| Return the output and start next Steps | RPCResult, with Output and NextSteps | RPCs |
| Cancel running Steps | RPCResult.CancelSteps | Cancel running Steps |
| Let a person invoke the RPC from Dex Web | Action of RPCOptions, with DefineAction | Actions |
| Invoke the RPC from a Client | Client.InvokeRPC | Invoke an RPC |
| Lock or load map instances chosen at call time | RPCInvokeOptions, with Client.InvokeRPCWithOptions | Runtime-selected map instances |