• Stars
    star
    113
  • Rank 310,115 (Top 7 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created almost 7 years ago
  • Updated almost 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Spin up and interact with virtual networks using Mininet and Node.js

mininet

Spin up and interact with virtual networks using Mininet and Node.js

npm install mininet

Usage

var mininet = require('mininet')

var mn = mininet()

// create a switch
var s1 = mn.createSwitch()

// create some hosts
var h1 = mn.createHost()
var h2 = mn.createHost()

// link them to the switch
h1.link(s1)
h2.link(s1)

// start the network
mn.start()

// run a server in node
var proc = h1.spawn('node server.js')

proc.on('message:listening', function () {
  // when h1 signals it is listening, run curl
  var proc2 = h2.spawn('curl --silent ' + h1.ip + ':10000')

  proc2.on('stdout', function (data) {
    process.stdout.write('h2 ' + data)
    mn.stop() // stop when h2 messages
  })
})

proc.on('stdout', function (data) {
  process.stdout.write('h1 ' + data)
})

Assuming server.js looks like this

var http = require('http')
var mn = require('mininet/host')

var server = http.createServer(function (req, res) {
  console.log('Server responding')
  res.end('hello from server\n')
})

server.listen(10000, function () {
  console.log('Server listening on', this.address().port)
  mn.send('listening') // msg the host
})

API

var mn = mininet([options])

Create a new mininet instance. Options include

{
  clean: false,         // if true run mn -c first
  sudo: true,           // use sudo if needed 
  sock: '/tmp/mn.sock', // explictly set the .sock file used
  debug: false,         // set to true to enable debug output
  stdio: null,          // passed to host.spawn as a default option
  prefixStdio: false    // passed to host.spawn as a default option
}

If for some reason your mininet instance stops working you probably wanna try using clean: true.

mn.start([callback])

Start the mininet network. Usually you call this after defining your hosts, switches and links.

After the network has fully started start is emitted.

mn.stop([callback])

Stop the mininet network. You should not call any other methods after this.

After the network has fully stopped stop is emitted.

mn.switches

Array of all created switches.

mn.hosts

Array of all created hosts.

var sw = mn.createSwitch()

Create a new switch

sw.link(other, [options])

Link the switch with another switch or host. Options include:

{
  bandwidth: 10,  // use 10mbit link
  delay: '100ms', // 100ms delay
  loss: 10,       // 10% package loss
  htb: true       // use htb
}

var host = mn.createHost()

Create an new host

host.ip

The IP address of the host. Populated after the network is started.

host.mac

The MAC address of the host. Populated after the network is started.

host.link(other, [options])

Link the host with another host or switch. Takes the same options as sw.link.

host.exec(cmd, [callback])

Execute a command and buffer the output and return it in the callback.

var proc = host.spawn(cmd, [options])

Spawn a new process to run the in background of the host. Options include:

{
  stdio: 'inherit', // set this to forward stdio
  prefixStdio: 'some-prefix' // all stdio is prefixed with this
}

If you set prefixStdio: true it will be converted to {host.id}.{process.id}. When debugging it can be useful to set both {stdio: 'inherit', prefixStdio: true}.

var proc = host.spawnNode(programSource, [options])

Helper that spawns a Node.js source inside the host. Useful when using multiline strings

host.spawnNode(`
  console.log('starting timer...')
  setInterval(() => console.log('Time is', Date.now()))
`, {
  stdio: 'inherit',
  prefixStdio: true
})

proc.id

Unique string id of the process

proc.kill([signal])

Kill the process.

proc.send(type, data)

Send a message to the process.

proc.on('stdout', data)

Emitted when the process has output.

proc.on('message', type, data)

Emitted when the process received a message.

proc.on('message:{type}', data)

Same as above but with the type as part of the event name for convenience.

proc.on('exit')

Emitted when the process exits.

Messaging

If you are spawning a node process you can require mininet/host to communicate with the host.

var host = require('mininet/host')

Require this in a spawned process.

host.send(type, data)

Send a message to the host.

host.sendTo(processId, type, data)

Send a message to another process.

host.broadcast(type, data)

Send a message to all processes.

host.on('message', type, data, metadata)

Emitted when a message is received from the host. The metadata argument contains the following data

{
  from: 'some-process-id-or-host' // who sent this message
}

host.on('message:{type}', data, metadata)

Same as above but with the type as part of the event name for convenience.

License

MIT

More Repositories

1

peerflix

Streaming torrent client for node.js
JavaScript
6,094
star
2

playback

Video player built using electron and node.js
JavaScript
2,009
star
3

torrent-stream

The low level streaming torrent engine that peerflix uses
JavaScript
1,941
star
4

why-is-node-running

Node is running but you don't know why? why-is-node-running is here to help you.
JavaScript
1,781
star
5

chromecasts

Query your local network for Chromecasts and have them play media
JavaScript
1,447
star
6

csv-parser

Streaming csv parser inspired by binary-csv that aims to be faster than everyone else
JavaScript
1,413
star
7

torrent-mount

Mount a torrent (or magnet link) as a filesystem in real time using torrent-stream and fuse. AKA MAD SCIENCE!
JavaScript
1,333
star
8

turbo-http

Blazing fast low level http server
JavaScript
996
star
9

is-my-json-valid

A JSONSchema validator that uses code generation to be extremely fast
JavaScript
961
star
10

pump

pipe streams together and close all of them if one of them closes
JavaScript
895
star
11

airpaste

A 1-1 network pipe that auto discovers other peers using mdns
JavaScript
819
star
12

hyperdb

Distributed scalable database
JavaScript
752
star
13

protocol-buffers

Protocol Buffers for Node.js
JavaScript
751
star
14

signalhub

Simple signalling server that can be used to coordinate handshaking with webrtc or other fun stuff.
JavaScript
667
star
15

turbo-json-parse

Turbocharged JSON.parse for type stable JSON data
JavaScript
613
star
16

turbo-net

Low level TCP library for Node.js
JavaScript
598
star
17

peercast

torrent-stream + chromecast
JavaScript
509
star
18

hyperbeam

A 1-1 end-to-end encrypted internet pipe powered by Hyperswarm
JavaScript
482
star
19

multicast-dns

Low level multicast-dns implementation in pure javascript
JavaScript
470
star
20

hyperlog

Merkle DAG that replicates based on scuttlebutt logs and causal linking
JavaScript
466
star
21

hypervision

P2P Television
JavaScript
445
star
22

webcat

Mad science p2p pipe across the web using webrtc that uses your Github private/public key for authentication and a signalhub for discovery
JavaScript
437
star
23

tar-stream

tar-stream is a streaming tar parser and generator.
JavaScript
381
star
24

webrtc-swarm

Create a swarm of p2p connections using webrtc and a signalhub
JavaScript
375
star
25

discovery-swarm

A network swarm that uses discovery-channel to find peers
JavaScript
375
star
26

tar-fs

fs bindings for tar-stream
JavaScript
339
star
27

torrent-docker

MAD SCIENCE realtime boot of remote docker images using bittorrent
JavaScript
314
star
28

fuse-bindings

Notice: We published the successor module to this here https://github.com/fuse-friends/fuse-native
C++
312
star
29

peerwiki

all of wikipedia on bittorrent
JavaScript
308
star
30

awesome-p2p

List of great p2p resources
301
star
31

hyperfs

A content-addressable union file system build on top of fuse, hyperlog, leveldb and node
JavaScript
270
star
32

respawn

Spawn a process and restart it if it crashes
JavaScript
254
star
33

pumpify

Combine an array of streams into a single duplex stream using pump and duplexify
JavaScript
252
star
34

polo

Polo is a zero configuration service discovery module written completely in Javascript.
JavaScript
246
star
35

benny-hill

Play the Benny Hill theme while running another command
JavaScript
242
star
36

streamx

An iteration of the Node.js core streams with a series of improvements.
JavaScript
224
star
37

mp4-stream

Streaming mp4 encoder and decoder
JavaScript
219
star
38

hyperphone

A telephone over Hyperbeam
JavaScript
198
star
39

flat-file-db

Fast in-process flat file database that caches all data in memory
JavaScript
196
star
40

diffy

A tiny framework for building diff based interactive command line tools.
JavaScript
191
star
41

dns-discovery

Discovery peers in a distributed system using regular dns and multicast dns.
JavaScript
190
star
42

duplexify

Turn a writable and readable stream into a streams2 duplex stream with support for async initialization and streams1/streams2 input
JavaScript
185
star
43

browser-server

A HTTP "server" in the browser that uses a service worker to allow you to easily send back your own stream of data.
JavaScript
185
star
44

browserify-fs

fs for the browser using level-filesystem and browserify
JavaScript
184
star
45

ims

Install My Stuff - an opinionated npm module installer
JavaScript
184
star
46

dns-packet

An abstract-encoding compliant module for encoding / decoding DNS packets
JavaScript
181
star
47

jitson

Just-In-Time JSON.parse compiler
JavaScript
178
star
48

dnsjack

A simple DNS proxy that lets you intercept domains and route them to whatever IP you decide.
JavaScript
172
star
49

nanobench

Simple benchmarking tool with TAP-like output that is easy to parse
JavaScript
169
star
50

localcast

A shared event emitter that works across multiple processes on the same machine, including the browser!
JavaScript
165
star
51

level-filesystem

Full implementation of the fs module on top of leveldb
JavaScript
164
star
52

dht-rpc

Make RPC calls over a Kademlia based DHT.
JavaScript
160
star
53

tetris

Play tetris in your terminal - in color
JavaScript
157
star
54

hyperssh

Run SSH over hyperswarm!
JavaScript
146
star
55

end-of-stream

Call a callback when a readable/writable/duplex stream has completed or failed.
JavaScript
145
star
56

flat-tree

A series of functions to map a binary tree to a list
JavaScript
141
star
57

lil-pids

Dead simple process manager with few features
JavaScript
140
star
58

airswarm

Network swarm that automagically discovers other peers on the network using multicast dns
JavaScript
127
star
59

wat2js

Compile WebAssembly .wat files to a common js module
JavaScript
127
star
60

node-modules

Search for node modules
JavaScript
127
star
61

ssh-exec

Execute a script over ssh using Node.JS
JavaScript
126
star
62

add-to-systemd

Small command line tool to simply add a service to systemd
JavaScript
125
star
63

deejay

Music player that broadcasts to everyone on the same network
JavaScript
124
star
64

protocol-buffers-schema

No nonsense protocol buffers schema parser written in Javascript
JavaScript
120
star
65

tree-to-string

Convert a tree structure into a human friendly string
JavaScript
120
star
66

unordered-array-remove

Efficiently remove an element from an unordered array without doing a splice
JavaScript
117
star
67

hyperpipe

Distributed input/output pipe.
JavaScript
116
star
68

abstract-chunk-store

A test suite and interface you can use to implement a chunk based storage backend
JavaScript
113
star
69

shared-structs

Share a struct backed by the same underlying buffer between C and JavaScript
JavaScript
113
star
70

p2p-workshop

a workshop to learn about p2p
HTML
111
star
71

jsonkv

Single file write-once database that is valid JSON with efficient random access on bigger datasets
JavaScript
109
star
72

ansi-diff-stream

A transform stream that diffs input buffers and outputs the diff as ANSI. If you pipe this to a terminal it will update the output with minimal changes
JavaScript
109
star
73

browser-sync-stream

Rsync between a server and the browser.
JavaScript
108
star
74

docker-registry-server

docker registry server in node.js
JavaScript
108
star
75

dns-socket

Make custom low-level DNS requests from node with retry support.
JavaScript
102
star
76

utp-native

Native bindings for libutp
JavaScript
100
star
77

taco-nginx

Bash script that runs a service and forwards a subdomain to it using nginx when it listens to $PORT
Shell
100
star
78

gunzip-maybe

Transform stream that gunzips its input if it is gzipped and just echoes it if not
JavaScript
98
star
79

merkle-tree-stream

A stream that generates a merkle tree based on the incoming data.
JavaScript
98
star
80

media-recorder-stream

The Media Recorder API in the browser as a readable stream
JavaScript
97
star
81

thunky

Delay the evaluation of a paramless async function and cache the result
JavaScript
97
star
82

peervision

a live p2p streaming protocol
JavaScript
97
star
83

noise-network

Authenticated P2P network backed by Hyperswarm and Noise
JavaScript
96
star
84

soundcloud-to-dat

Download all music from a Soundcloud url and put it into a Dat
JavaScript
96
star
85

blecat

1-1 pipe over bluetooth low energy
JavaScript
95
star
86

debugment

A debug comment -> debugment
JavaScript
93
star
87

hyperdht

A DHT that supports peer discovery and distributed hole punching
JavaScript
93
star
88

docker-browser-console

Forward input/output from docker containers to your browser
JavaScript
90
star
89

srt-to-vtt

Transform stream that converts srt files to vtt files (html5 video subtitles)
JavaScript
89
star
90

speedometer

speed measurement in javascript
JavaScript
88
star
91

mutexify

Bike shed mutex lock implementation
JavaScript
88
star
92

p2p-file-sharing-workshop

A workshop where you learn about distributed file sharing
HTML
88
star
93

mirror-folder

Small module to mirror a folder to another folder. Supports live mode as well.
JavaScript
87
star
94

utp

utp (micro transport protocol) implementation in node
JavaScript
86
star
95

echo-servers.c

A collection of various echo servers in c
C
83
star
96

recursive-watch

Minimal recursive file watcher
JavaScript
82
star
97

docker-browser-server

Spawn and expose docker containers over http and websockets
JavaScript
80
star
98

are-feross-and-mafintosh-stuck-in-an-elevator

Are @feross and @mafintosh stuck in an elevator?
JavaScript
79
star
99

parallel-transform

Transform stream for Node.js that allows you to run your transforms in parallel without changing the order
JavaScript
79
star
100

peer-wire-swarm

swarm implementation for bittorrent
JavaScript
79
star