api notes

docs/zt_llapi_unity.md

@@ -0,0 +1,57 @@
+ZeroTier Unity LLAPI
+====
+
+We've tried to replicate the behavior of the Unity3D LLAPI to make using ZeroTier as easy as possible. Everything is handled via a `ZeroTierNetworkInterface` object. You can use it as follows:
+
+## Creating a host and receiving data
+
+```
+public class MyObject
+{
+	private ZeroTierNetworkInterface zt;
+
+	void Start()
+	{
+		zt = new ZeroTierNetworkInterface("/Users/Bob/UnityGame/nc_8c493f5bef1747a6");
+		zt.AddHost();
+	}
+
+	void Update()
+	{
+		NetworkEventType ne = zt.Receive();
+
+		switch(ne)
+		{
+			case NetworkEventType.ConnectEvent:
+				Debug.Log("Client connected!");
+				break;
+			case NetworkEventType.DataEvent:
+				Debug.Log("Received data from client!");
+		}
+	}
+	
+}
+```
+
+## Connecting to a server and sending a message
+
+public class MyObject
+{
+	private ZeroTierNetworkInterface zt;
+
+	void Start()
+	{
+		zt = new ZeroTierNetworkInterface("/Users/Bob/UnityGame/nc_8c493f5bef1747a6");
+
+		byte error;
+		int conn_id = zt.Connect(0, "192.168.0.50", "8080", out error);
+
+		if(conn_id) {
+			zt.Send(conn_id, "Welcome to the machine!", 24, error);
+		}
+		else {
+			Debug.Log("Unable to connect to host");
+		}
+
+	}
+}