Crate ockam_node

ockam_node - Ockam Node API

Re-exports

pub use tokio;

Modules

access_control

Access Control

api

Api helpers

channel_types

MPSC channel type aliases

compat

Async Mutex and RwLock

Structs

Cancel

A message wrapper type that allows users to cancel message receival

Context

Context contains Node state and references to the runtime.

DelayedEvent

Allow to send message to destination address periodically after some delay Only one scheduled heartbeat allowed at a time Dropping this handle cancels scheduled heartbeat

Executor

Underlying Ockam node executor

ExternalLocalInfo

Used for LocalMessage that originates from outside the node (e.g. received from transport)

NodeBuilder

Start a node with a custom setup configuration

NullWorker

A minimal worker implementation that does nothing

WorkerBuilder

Start a Worker with a custom AccessControl configuration

Enums

NodeError

Enumeration of error causes in ockam_node

NodeMessage

Messages sent from the Node to the Executor

NodeReason

Reasons why a generic Ockam Node operation has failed

RouterReason

Reasons why adding an external router has failed

RouterReply

Successful return values from a router command

ShutdownType

Specify the type of node shutdown

WorkerReason

Reasons why a worker operation has failed

Constants

DEFAULT_TIMEOUT

A default timeout in seconds

EXTERNAL_IDENTIFIER

Node LocalInfo unique Identifier

Type Definitions

AsyncDropSender

A special sender type that connects a type to an AsyncDrop handler

DetachedContext

A special type of Context that has no worker relay and inherits the parent Context’s access control

NodeReplyResult

The reply/result of a Node

RepeaterContext

A special type of Context that has no worker relay and a custom access control which is not inherited from its parent `Context.