Client\nCreates a WebSocket Client for handling events across different applications. Requires a running Server.
\nEvent\nThe Event class contains methods for creating and managing event handlers.
\nService that handles the creation and management of events.
\nServer\nCreates a WebSocket Server for the managing of events across multiple applications. Allows connections only from Clients that have been registered using server.registerService(serviceName).
\nstring | The unique identifier for this message. This may be valuable for distinguising between iterations of a single event that it called multiple times. |\n| destination | string \\| undefined | Optional. The intended recipient service of this message. If the service is not registered with the Server, the message will be ignored. If this argument is omitted, it is assumed that the [Event](#Event) is meant to be handled locally. |\n| origin | string | The service that the [Event](#Event) originated from. |\n| eventId | string | An identifier for the [Event](#Event). While the identifier must be unique for Events on a service, different services may share Event identifiers. It is also possible for a single event to be raised multiple times. |\n| payload | T | Optional. If provided, this generic ([T](T)) object will be passed to events at the destination service as the data for event handlers. |\n\n\n\n## Client\nClient\nCreates a WebSocket Client for handling events across different applications. Requires a running [Server](#Server).\n\n**Kind**: global class \n\n* [Client](#Client)\n * [.run(port, serviceName, ip)](#Client+run)\n * [.send(message)](#Client+send)\n * [.stop()](#Client+stop)\n\n\n\n### client.run(port, serviceName, ip)\nInitializes the EventService Client.\n\n**Kind**: instance method of [Client](#Client) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| port | number | The port number to connect to. |\n| serviceName | string | The name of the service. Must be unique, and must be registered with the server. |\n| ip | string | If provided, the IP address of the WebSocket Server. If this is left null, then the Client will assume the WebSocket Server is hosted at localhost. |\n\n\n\n### client.send(message)\nSends a [Message](#Message) to the\nServer, which will route the message to its destination.\n\n**Kind**: instance method of [Client](#Client) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| message | [Message](#Message) | The message object which contains the parameters needed to handle the message, as well as the message itself. |\n\n\n\n### client.stop()\nStops the client\n\n**Kind**: instance method of [Client](#Client) \n\n\n## Event\nEvent\nThe Event class contains methods for creating and managing event handlers.\n\n**Kind**: global class \n\n* [Event](#Event)\n * [.addListener(callback, id)](#Event+addListener) ⇒ string\n * [.removeListener(id)](#Event+removeListener)\n * [.raise(data, destination)](#Event+raise)\n * [.listListeners()](#Event+listListeners) ⇒ Array.<string>\n\n\n\n### event.addListener(callback, id) ⇒ string\nAdds a listener to the [Event](#Event). If the [Event](#Event) is [raise](raise)d,\nthen any registered listeners will be called.\n\n**Kind**: instance method of [Event](#Event) \n**Returns**: string - Returns the unique identifier of the event handler, which\ncan be used to remove the listener. \n**Throws**:\n\n- Invalid Identifier error if id is not unique\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| callback | function | The function to call when the [Event](#Event) is [raise](raise)d. |\n| id | string | If provided, will act as the identifier for this event handler. The id _must_ be uniquem or an error will be thrown. |\n\n\n\n### event.removeListener(id)\nRemoves a litener using its unique identifier\n\n**Kind**: instance method of [Event](#Event) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | string | The unique identifier of the event to be removed. |\n\n\n\n### event.raise(data, destination)\nRaises the [Event](#Event). When an [Event](#Event) is raised, all of its event handlers\nare called.\n\n**Kind**: instance method of [Event](#Event) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| data | any | The data that is sent along to an event handler as an argument |\n| destination | string | If a destination is specified _and_ the service has been initalized as either a server or a client, then this will direct the server to forward this event to the correct service, given that the service is registered with the server. |\n\n\n\n### event.listListeners() ⇒ Array.<string>\nLists the unique identifiers of the current listeners.\n\n**Kind**: instance method of [Event](#Event) \n\n\n## EventService\nService that handles the creation and management of events.\n\n**Kind**: global class \n\n\n### EventService.Event(id) ⇒ [Event](#Event)\nEvent factory.\n\nIf called with the id of an existing [Event](#Event), will\nreturn that [Event](#Event). Otherwise, will create and return a\nnew [Event](#Event). If the service has been initalized as either a client\nor server, this will also add an event handler for pushing event data\nto the appropriate WebSockets.\n\n**Kind**: static method of [EventService](#EventService) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| id | string | The unique identifier for the event. |\n\n\n\n## Server\nServer\nCreates a WebSocket Server for the managing of events across multiple applications. Allows connections only from [Client](#Client)s that have been registered using server.registerService(serviceName).\n\n**Kind**: global class \n\n* [Server](#Server)\n * [.run(port)](#Server+run)\n * [.registerService(serviceName)](#Server+registerService)\n * [.send(message)](#Server+send)\n * [.stop()](#Server+stop)\n\n\n\n### server.run(port)\nRuns the WebSocket Server, which listens for, processes, and emits the events that makes all the different\nservices communicate. In order for the EventService to function between applications, exactly one _must_\nbe functioning as a server.\n\n**Kind**: instance method of [Server](#Server) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| port | number | The port to host the Server on. |\n\n\n\n### server.registerService(serviceName)\nAdds the given service name to the list of registered services.\n\n**Kind**: instance method of [Server](#Server) \n**Throws**:\n\n- \"Invalid Identifier\" if the entry already exists.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| serviceName | string | The name of the service being added. |\n\n\n\n### server.send(message)\nSends a [Message](#Message) to the appropriate service, based on the\n[Message.destination](Message.destination).\n\n**Kind**: instance method of [Server](#Server) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| message | [Message](#Message) | The message object which contains the parameters needed to handle the message, as well as the message itself. |\n\n\n\n### server.stop()\nStops the server\n\n**Kind**: instance method of [Server](#Server) \n","readmeFilename":"README.md"}