forks-communicator

    0.1.2 • Public • Published

    Node.js fork communicator (messages between processes)

    Small library for communication between forks. This library is created for small projects that do not need to store queues and no guarantee of receipt. For more complex tasks, use rabbitmq or another message-broker.

    Install

    npm install forks-communicator --save

    Usage examples

    Examples available here!

    Just clone, go to the example directory and run fork.js or worker.js.

    fork.js - Fork example

    Create master and forks then wrap forks to the communicator. For master use forks-communicator and for forks forks-communicator/fork.

    const { setup, subscribe, emit } = require("forks-communicator");
    const { fork } = require("child_process");
    const { join } = require("path");
     
    // Wrap forks in the communicator
    setup(fork(join(__dirname, "/child/process.js")));
    setup(fork(join(__dirname, "/child/another_process.js")));
     
    // Subscribe to channels from master process
    subscribe("say", ({ message }) => console.log(`[master] recived: ${message}`));
    subscribe("requestYeah", () => {
      // Send message from master to all subscribtions
      emit("all", "yeah");
    });

    worker.js - Worker example

    Create master and forks then wrap forks to the communicator. For master use forks-communicator and for forks forks-communicator/fork.

    const { setup, subscribe, emit } = require("../index");
    const { Worker } = require("worker_threads");
    const { join } = require("path");
     
    // Wrap forks in the communicator
    setup(new Worker(join(__dirname, "/child/process.js")));
    setup(new Worker(join(__dirname, "/child/another_process.js")));
     
    // Subscribe to channels from master process
    subscribe("say", ({ message }) => console.log(`[master] recived: ${message}`));
    subscribe("requestYeah", () => {
      // Send message from master to all subscribtions
      emit("all", "yeah");
    });
     

    child/process.js

    const { emit, subscribe } = require("forks-communicator/fork");
     
    // Subscribe to channel from fork process
    subscribe("all", ({ message }) => {
      console.log(`[fork] Message for all ${message}`);
    });
     
    // Emit message to "say" channel from fork process
    emit("say", "[fork] Meow from fork");
     
    // Emit message to "meow" channel after second from fork process
    setTimeout(() => {
      emit("meow", "[fork] Meow to another fork");
    }, 1000);

    child/another_process.js

    const { emit, subscribe } = require("forks-communicator/fork");
     
    const all = subscribe("all", ({ message }) => {
      console.log(`[another fork] Message for all ${message}`);
    });
     
    subscribe("meow", ({ message }) => {
      console.log(`[another fork] Meow recived: ${message}`);
      emit("requestYeah");
     
      // Unsubscribe fork :)
      all.unsubscribe();
    });
     
    emit("say", "[another fork] Meow from another fork");

    Work result

    [master] recived: [fork] Meow from fork
    [master] recived: [another fork] Meow from another fork
    [another fork] Meow recived: [fork] Meow to another fork
    [fork] Message for all yeah

    Install

    npm i forks-communicator

    DownloadsWeekly Downloads

    0

    Version

    0.1.2

    License

    MIT

    Unpacked Size

    7.78 kB

    Total Files

    5

    Last publish

    Collaborators

    • hinex