Add custom identities

Author: migeyel

README.md

@@ -29,15 +29,27 @@ Closes a modem for communications.
 ### `ecnet2.isOpen([modem: string])`
 Returns whether a modem is open for communications.
 
+### `ecnet2.Identity(path: string)`
+Creates or loads in an identity from a given identity directory path.
+
 ### `ecnet2.address(): string`
-Returns the address for connecting to this device.
+DEPRECATED. Use `ecnet2.Identity("/.ecnet2").address` instead.
+
+### `ecnet2.Protocol(interface: IProtocol): Protocol`
+DEPRECATED. Use `ecnet2.Identity("/.ecnet2"):Protocol(...)` instead.
 
 ### `ecnet2.daemon`
 Function used for managing listener and connection events.
 Intended to be put in parallel with users code.
 
-### `ecnet2.Protocol(interface: IProtocol): Protocol`
-Creates a protocol from a given interface.
+## Type `Identity`
+Contains secret data needed to communicate under an address.
+
+### `Identity.address: string`
+The address for connecting to this device through this identity.
+
+### `Identity:Protocol(interface: IProtocol): Protocol`
+Creates a protocol from a given interface under this identity.
 
 ## Type `IProtocol`
 A table containing a description for a protocol.

ecnet2/init.lua

@@ -1,8 +1,8 @@
 local constants = require "ecnet2.constants"
 local Identity = require "ecnet2.Identity"
 local modems = require "ecnet2.modems"
-local Protocol = require "ecnet2.Protocol"
 local ecnetd = require "ecnet2.ecnetd"
+local expect = require "cc.expect"
 
 local module = {}
 
@@ -14,7 +14,15 @@ local function fetchIdentity()
     return identity
 end
 
+--- Loads or creates an identity file in the given path.
+--- @param path string The path to load or create the identity at.
+--- @return ecnet2.Identity
+function module.Identity(path)
+    return Identity(expect(1, path, "string"))
+end
+
 --- Returns the address for this device.
+--- @deprecated Use `ecnet2.Identity("/.ecnet2").address` instead.
 --- @return string address The address.
 function module.address()
     return fetchIdentity().address
@@ -27,10 +35,11 @@ module.isOpen = modems.isOpen
 module.daemon = ecnetd.daemon
 
 --- Creates a protocol from a given interface.
+--- @deprecated Use `ecnet2.Identity("/.ecnet2"):Protocol(...)` instead.
 --- @param interface ecnet2.IProtocol A table describing the protocol.
 --- @return ecnet2.Protocol protocol The resulting protocol.
 function module.Protocol(interface)
-    return Protocol(interface, fetchIdentity())
+    return fetchIdentity():Protocol(interface)
 end
 
 return module

examples/ping/client.lua

@@ -12,8 +12,11 @@ http.websocket(data.url).close()
 -- Open the top modem for comms.
 ecnet2.open("top")
 
+-- Define an identity.
+local id = ecnet2.Identity("/.ecnet2")
+
 -- Define a protocol.
-local ping = ecnet2.Protocol {
+local ping = id:Protocol {
     -- Programs will only see packets sent on the same protocol.
     -- Only one active listener can exist at any time for a given protocol name.
     name = "ping",
@@ -40,4 +43,4 @@ local function main()
     end
 end
 
-parallel.waitForAny(main, ecnet2.daemon)
+parallel.waitForAny(main, ecnet2.daemon)

examples/ping/server.lua

@@ -11,8 +11,11 @@ http.websocket(data.url).close()
 -- Open the top modem for comms.
 ecnet2.open("top")
 
+-- Define an identity.
+local id = ecnet2.Identity("/.ecnet2")
+
 -- Define a protocol.
-local ping = ecnet2.Protocol {
+local ping = id:Protocol {
     -- Programs will only see packets sent on the same protocol.
     -- Only one active listener can exist at any time for a given protocol name.
     name = "ping",