lanicon / watsonmesh

A simple mesh networking library in C# based on WatsonTcp

Watson Mesh Networking

A simple C# mesh networking library using TCP (with or without SSL) with integrated framing for reliable transmission and receipt of data amongst multiple nodes.

New in v3.1.0

• Breaking changes
• Now only 127.0.0.1 or a valid IP address bound to a local network adapter are allowed
• Constructor changes to MeshNode

What is Watson Mesh?

Watson Mesh is a simple library for mesh networking. Instantiate the WatsonMesh class after defining the mesh network settings in MeshSettings and the local server configuration in Peer. Then, add Peer objects representing the other nodes in the network. Each WatsonMesh node runs a local server and one client for each defined Peer. By default, a node will attempt to reconnect to each of the configured peers should the connection become severed.

The network IsHealthy from a node's perspective if it has established outbound connections to each of its defined peers. Thus, the health of the network is determined by each node from its own viewpoint. The state of inbound connections from other nodes is not considered, but rather its ability to reach out to its peers.

Under the hood, WatsonMesh relies on WatsonTcp (see https://github.com/jchristn/WatsonTcp) for framing and reliable delivery.

Test App

Refer to the Test project for a full working example. Multiple instances can be started with each server listening on a different port. Then add each node as peers on each of the nodes you start.

Local vs External Connections

IMPORTANT

The IP address you specify determines whether or not WatsonMesh will allow external connections.

• If you specify 127.0.0.1 as the IP address, WatsonMesh will only be able to accept connections from within the local host.
• To accept connections from other machines:
  • Use a specific interface IP address (i.e. ipconfig from Command Prompt or ifconfig from Linux shell)
  • Make sure you create a permit rule on your firewall to allow inbound connections on that port
• If you use a port number under 1024, admin privileges will be required

REMINDER If you use 127.0.0.1 as your IP address, WatsonMesh will only be allowed to receive connections from the local machine.

Known Limitations

WatsonMesh will not work in environments where NAT (Network Address Translation) exists in between members of the mesh network.

Example

The following example shows a simple example using byte arrays and without SSL. Make sure you start instances for mesh nodes running on ports 8000, 8001, and 8002. You can use multiple instances of the Test project to see a more complete example.

using WatsonMesh; 

// initialize
MeshNode mesh = new MeshNode("127.0.0.1", 8000);

// define callbacks and start
mesh.PeerConnected += PeerConnected;
mesh.PeerDisconnected += PeerDisconnected;
mesh.MessageReceived += MessageReceived; 
mesh.SyncMessageReceived = SyncMessageReceived;
mesh.Start();

// add peers 
mesh.Add(new Peer("127.0.0.1:8001"));
mesh.Add(new Peer("127.0.0.1:8002")); 

// implement callbacks

static void PeerConnected(object sender, ServerConnectionEventArgs args) 
{
    Console.WriteLine("Peer " + args.PeerNode.ToString() + " connected!");
}

static void PeerDisconnected(object sender, ServerConnectionEventArgs args) 
{
    Console.WriteLine("Peer " + args.PeerNode.ToString() + " disconnected!");
}

static void MessageReceived(object sender, MessageReceivedEventArgs args) 
{
	Console.WriteLine("Message from " + args.SourceIpPort + ": " + Encoding.UTF8.GetBytes(args.Data));
}

static SyncResponse SyncMessageReceived(MessageReceivedEventArgs args) 
{
	Console.WriteLine("Message from " + args.SourceIpPort + ": " + Encoding.UTF8.GetBytes(args.Data));
	return new SyncResponse(SyncResponseStatus.Success, "Hello back at you!");
}

// send messages 
if (!mesh.Send("127.0.0.1:8001", "Hello, world!")) { // handle errors }
if (!mesh.Broadcast("Hello, world!")) { // handle errors }
SyncResponse resp = mesh.SendSync("127.0.0.1:8001", 5000, "Hello, world!");

Running under Mono

The preferred framework for WatsonMesh for multiplatform environments is .NET Core. However, the project works well in Mono environments with hte .NET Frameworks to the extent that we have tested it. It is recommended that when running under Mono, you execute the containing EXE using --server and after using the Mono Ahead-of-Time Compiler (AOT). Note that TLS 1.2 is hard-coded, which may need to be downgraded to TLS in Mono environments.

NOTE: Windows accepts '0.0.0.0' as an IP address representing any interface. On Mac and Linux you must be specified ('127.0.0.1' is also acceptable, but '0.0.0.0' is NOT).

mono --aot=nrgctx-trampolines=8096,nimt-trampolines=8096,ntrampolines=4048 --server myapp.exe
mono --server myapp.exe

Version History

Refer to CHANGELOG.md for a list of changes by version.