Crate ockam_api

This crate supports the creation of a fully-featured Ockam Node (see NodeManager in src/nodes/service.rs).

Configuration

A NodeManager maintains its database and log files on disk in the OCKAM_HOME directory (~/.ockam) by default:

root
├─ database.sqlite
├─ nodes
│  ├─ node1
│  │  ├─ stderr.log
│  │  ├─ stdout.log
│  ├─ node2
│  └─ ...

Re-exports

• pub use cli_state::CliState;
• pub use error::*;
• pub use nodes::service::default_address::*;

Modules

• address
• authenticator
• authority_node
• cli_state
• cloud
• colors
• config
• echoer
• enroll
• error
• hop
• kafka
  This service allows encrypted transparent communication from the kafka producer to the kafka consumer without any modification in the existing application.
• logs
• minicbor_url
• nodes
• okta
• output
• port_range
• terminal
• test_utils
• uppercase

Macros

• color
• fmt_err
• fmt_heading
• fmt_info
• fmt_list
• fmt_log
• fmt_ok
• fmt_para
• fmt_warn

Structs

• MultiAddrToRouteResult
• Version

Enums

• ConnectionStatus

Traits

• InfluxDbTokenLease

Functions

• addr_to_multiaddr
  Try to convert an Ockam Address into a MultiAddr.
• is_local_node
  Tells whether the input MultiAddr references a local node or a remote node.
• local_multiaddr_to_route
  Try to convert a multi-address to an Ockam route.
• local_worker
  Tells whether the input Code references a local worker.
• multiaddr_to_addr
  Try to convert a multiaddr to an Ockam Address
• multiaddr_to_route
• multiaddr_to_transport_route
  Resolve all the multiaddresses which represent transport addresses For example /tcp/127.0.0.1/port/4000 is transformed to the Address (TCP, “127.0.0.1:4000”) The creation of a TCP worker and the substitution of that transport address to a worker address is done later with context.resolve_transport_route(route)
• route_to_multiaddr
  Convert an Ockam Route into a MultiAddr.
• try_address_to_multiaddr
  Try to convert an Ockam Address to a MultiAddr.
• try_multiaddr_to_addr
• try_route_to_multiaddr
  Try to convert an Ockam Route into a MultiAddr.