Manual:Modules/NetworkBinder

From MSure

The NetworkBinder is a module that allows two or more instances of MSure to communicate across a TCP/IP network.

This module allows for a decentralized installation. For example, it might be beneficial to run one instance of MSure on a computer at location A, where the 1-Wire network access point is located, and a second instance at location B, which might be the best location to place a Tellstick device. By connecting these two instances using the NetworkBinder, it is still possible to react to sensor input from the 1-Wire network at location B.

Configuration

The configuration template looks as follows

<?xml version="1.0" encoding="utf-8"?>
<ModuleConfig xmlns:xi="http://www.w3.org/2001/XInclude" xml:base=".">
  <CoreConfig>
    <Alias>NetworkBinder</Alias>
    <ClassName>NetworkBinder</ClassName>
  </CoreConfig>
  <NetworkBinder Address="{remote_server}" ReconnectInterval="[15|1..n]" TCPPort="[6000]">
	<!-- The license element is optional, but leaving it out puts the module in evaluation mode -->
	<License Name="" Email="" Key=""/>
  </NetworkBinder>
</ModuleConfig>

This module only has one required setting, the Address of the remote server to which it shall connect to. The other settings can safely be left to their default values, or left out entirely.

Network topology

Network topology

Connecting two instances of MSure using the NetworkBinder requires a single instance of the module to be loaded in one of the instances. In fact, only one instance of the module should be loaded in this case. When connecting three or more instances, it is important to make sure that a circular network is not created, as indicated by the red arrow in the illustration. If a circular network is created, messages will have two ways between two endpoints and due to how the message distribution works, each message will be delivered twice which may cause an unexpected behaviour. As indicated by the illustration, messages may be distributed across the running instances in any way; from a module's point of view they are all running in the same instance and can communicate with other modules seamlessly.

Evaluation mode

Unlike other parts of MSure, this module is only available for production use for Donors. Anyone can download and try it, but without a valid license key the module will stop functioning after a random time has passed (always > 30 minutes)

License key

If you are an eligible Donor, you can access the license key through your forum account, under the Account settings. The different attributes of the License-element shall be filled in with the data found on that page.