Skip to content

Fix Event Names #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 27, 2017
Merged

Fix Event Names #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f05e1a9
Update subscription names
tabone Aug 27, 2017
7cb25cb
Add documentation about error event
tabone Aug 27, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,10 @@ The following table contains the events emitted by TCP Emitter server

Name | Description
----------- | -----------
`subscribe` | Event emitted when a `TCP Emitter client` subscribes to a TCP Emitter event. The listeners of this event are invoked with the `TCP Emitter client` & `event name`. Note when a `TCP Emitter client` requests to subscribe to an event that it is already subscribed to, this event is not emitted.
`unsubscribe` | Event emitted when a `TCP Emitter client` unsubscribes to a TCP Emitter event. The listeners of this event are invoked with the `TCP Emitter client` & `event name`. Note when a `TCP Emitter client` requests to unsubscribe from an event that it is not subscribed to, this event is not emitted.
`broadcast` | Event emitted when a `TCP Emitter client` broadcasts to a TCP Emitter event. The listeners of this event are invoked with the `TCP Emitter client`, `event name` & `broadcast arguments`.
`tcp-emitter-subscribe` | Event emitted when a `TCP Emitter client` subscribes to a TCP Emitter event. The listeners of this event are invoked with the `TCP Emitter client` & `event name`. Note when a `TCP Emitter client` requests to subscribe to an event that it is already subscribed to, this event is not emitted.
`tcp-emitter-unsubscribe` | Event emitted when a `TCP Emitter client` unsubscribes to a TCP Emitter event. The listeners of this event are invoked with the `TCP Emitter client` & `event name`. Note when a `TCP Emitter client` requests to unsubscribe from an event that it is not subscribed to, this event is not emitted.
`tcp-emitter-broadcast` | Event emitted when a `TCP Emitter client` broadcasts to a TCP Emitter event. The listeners of this event are invoked with the `TCP Emitter client`, `event name` & `broadcast arguments`.
`error` | Emitted when an error occurs.

# TCP Emitter Clients
As specified in the introduction, these can be implemented in any language as long as they follow the TCP Emitter Payload spec. A TCP Emitter client can do the following three different interactions with the `TCP Emitter server`:
Expand Down