Mailbox - old new way of inter-thread communication.

A bit of history, a bit of theory

Why?

Example of usage - 'Echo'

// Mbx is Mailbox with usize letter(data)constMbx=mailbox.MailBox(usize);// Echo - runs on own thread// It has two mailboxes// "TO" and "FROM" - from the client point of the view// Receives letter via 'TO' mailbox// Replies letter without change (echo) to "FROM" mailboxconstEcho=struct {constSelf=@This();to:Mbx=undefined,from:Mbx=undefined,thread:Thread=undefined,// Mailboxes creation and start of the thread// Pay attention, that client code does not use// any thread "API" - all embedded within Echopubfnstart(echo:*Self)void {echo.to= .{};echo.from= .{};echo.thread=std.Thread.spawn(.{},run, .{echo})catchunreachable;        }// Echo thread functionfnrun(echo:*Self)void {// Main loop:while (true) {// Receive - exit from the thread if mailbox was closedconstenvelope=echo.to.receive(100000000)catchbreak;// Reply to the client// Exit from the thread if mailbox was closed_=echo.from.send(envelope)catchbreak;            }        }// Wait exit from the threadpubfnwaitFinish(echo:*Self)void {echo.thread.join();        }// Close mailboxes// As result Echo should stop processing// and exit from the thread.pubfnstop(echo:*Self)!void {_=echo.to.close();_=echo.from.close();        }    };varecho=trystd.testing.allocator.create(Echo);// Start Echo(on own thread)echo.start();deferecho.stop();defer {// Wait finish of Echoecho.waitFinish();std.testing.allocator.destroy(echo);    }// because nothing was send to 'TO' mailbox, nothing should be received// from 'FROM' mailboxtrytesting.expectError(error.Timeout,echo.from.receive(100));// Create wrapper for the dataconstenvl=trystd.testing.allocator.create(Mbx.Envelope);deferstd.testing.allocator.destroy(envl);// Send/Receive loopfor (0..6)|indx| {// Set value for send [0-5]envl.letter=indx;// Send to 'TO' mailboxtryecho.to.send(envl);// Wait received data from OUT mailboxconstback=echo.from.receive(1000000);if (back)|val| {// Expected value == index [0-5]trytesting.expect(val.letter==indx);        }else|_| {trytesting.expect(false);        }    }

Boring details

constRumors=mailbox.MailBox([]constu8);constrmrsMbx :Rumors= .{};

pubconstEnvelope=struct {prev:?*Envelope=null,next:?*Envelope=null,letter:Letter,        };

Intrusive mailbox

pubconstT=struct {prev:?*T=null,next:?*T=null,additionalstuff  };

constMsgU32=struct {prev:?*MsgU32=null,next:?*MsgU32=null,stuff:u32=undefined,  };

Eat your own dog food

Installation

cd my-example-projectzig fetch --save=mailbox git+https://github.com/g41797/mailbox

.{    .name="My example project",    .version="0.0.1",    .dependencies= .{        .mailbox= .{            .url="git+https://github.com/g41797/mailbox#3f794f34f5d859e7090c608da998f3b8856f8329",            .hash="122068e7811ec1bfc2a81c9250078dd5dafa9dca4eb3f1910191ba060585526f03fe",        },    },    .paths= .{"",    },}

constmailbox=b.dependency("mailbox", .{        .target=target,        .optimize=optimize,    });exe.root_module.addImport("mailbox",mailbox.module("mailbox"));

License

Last warning