Skip to main content

Initialization Flow

The five typical message flows that occur in NSB, shown with their complete manifest, metadata, and message field values — plus how to construct, serialize, and parse the nsbm Protobuf message in both Python and C++.

1. Client INIT Handshake​

Client → Daemon
  manifest.op     = INIT
  manifest.og     = APP_CLIENT (or SIM_CLIENT)
  manifest.code   = CLIENT_REQUEST
  message.intro   = IntroDetails { identifier, address, channels }

Daemon → Client
  manifest.op     = INIT
  manifest.og     = DAEMON
  manifest.code   = DAEMON_RESPONSE
  message.config  = ConfigParams { sys_mode, sim_mode, use_db, ... }

2. AppClient SEND​

AppClient → Daemon
  manifest.op       = SEND
  manifest.og       = APP_CLIENT
  manifest.code     = EXPLICIT_TARGET (or IMPLICIT_TARGET)
  metadata.src_id   = "node0"
  metadata.dest_id  = "node1"
  metadata.size     = <payload size>
  message.payload   = <raw bytes>   (or message.msg_key if use_db)

3. SimClient FETCH (PULL mode)​

SimClient → Daemon
  manifest.op      = FETCH
  manifest.og      = SIM_CLIENT
  manifest.code    = CLIENT_REQUEST

Daemon → SimClient (if message available)
  manifest.op      = FETCH
  manifest.og      = DAEMON
  manifest.code    = MESSAGE
  metadata.src_id  = "node0"
  metadata.dest_id = "node1"
  message.payload  = <raw bytes>

Daemon → SimClient (if no message)
  manifest.code    = NO_MESSAGE

4. SimClient POST​

SimClient → Daemon
  manifest.op       = POST
  manifest.og       = SIM_CLIENT
  metadata.src_id   = "node0"
  metadata.dest_id  = "node1"
  message.payload   = <delivered payload>

5. AppClient RECEIVE (PULL mode)​

AppClient → Daemon
  manifest.op     = RECEIVE
  manifest.og     = APP_CLIENT
  manifest.code   = CLIENT_REQUEST (or EXPLICIT_TARGET if dest_id specified)

Daemon → AppClient (if message available)
  manifest.code   = MESSAGE
  metadata        = { src, dest, size }
  message.payload = <payload>

Daemon → AppClient (if no message)
  manifest.code   = NO_MESSAGE

Using the Proto in Python​

from proto.proto import nsb_pb2

# Create a message
msg = nsb_pb2.nsbm()
msg.manifest.op = nsb_pb2.nsbm.Manifest.Operation.SEND
msg.manifest.og = nsb_pb2.nsbm.Manifest.Originator.APP_CLIENT
msg.manifest.code = nsb_pb2.nsbm.Manifest.OpCode.CLIENT_REQUEST
msg.metadata.src_id = "node0"
msg.metadata.dest_id = "node1"
msg.payload = b"Hello!"

# Serialize
data = msg.SerializeToString()

# Deserialize
received = nsb_pb2.nsbm()
received.ParseFromString(data)
print(received.metadata.src_id)

Using the Proto in C++​

#include "nsb.pb.h"

nsb::nsbm msg;
msg.mutable_manifest()->set_op(nsb::nsbm::Manifest::SEND);
msg.mutable_manifest()->set_og(nsb::nsbm::Manifest::APP_CLIENT);
msg.mutable_metadata()->set_src_id("node0");
msg.mutable_metadata()->set_dest_id("node1");
msg.set_payload("Hello!");

// Serialize
std::string serialized;
msg.SerializeToString(&serialized);

// Deserialize
nsb::nsbm received;
received.ParseFromString(serialized);
std::cout << received.metadata().src_id() << std::endl;

Go Deeper​