Skip to content
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

Jump to bottom

Fix broken headings in Markdown files #19

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix broken headings in Markdown files #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Self-contained on the client. On the server, Push-It is tested with Node 0.4.7


## Workflow
###1. An agent connects
### 1. An agent connects

PushIt.onConnectionRequest = function(agent){}

Expand All @@ -82,7 +82,7 @@ Self-contained on the client. On the server, Push-It is tested with Node 0.4.7
3. if they are invalid or you have an error, call agent.connectionDenied(reason)
4. if you do not call disconnect or connected, they will be denied after pushIt.TIMEOUTS.onConnectionRequest milliseconds

###2. An agent subscribes to channels
### 2. An agent subscribes to channels

The system will use the channel-specific function if the channel and function exist and will fall back to the default otherwise.

Expand All @@ -94,7 +94,7 @@ Self-contained on the client. On the server, Push-It is tested with Node 0.4.7
3. if the agent is not allowed to receive on this channel, call agent.subscriptionDenied(channel, reason)
4. if you do not call subscribe or subscriptionDenied, they will be automatically disconnected after pushIt.TIMEOUTS.onSubscriptionRequest milliseconds

###3. An agent publishes to channels
### 3. An agent publishes to channels

The system will use the channel-specific function if the channel and function exist and will fall back to the default otherwise.

Expand All @@ -107,7 +107,7 @@ Self-contained on the client. On the server, Push-It is tested with Node 0.4.7
4. if the agent is not allowed to publish on this channel, call agent.publicationDenied(message, reason)
5. if you do not call agent.publicationDenied or agent.publicationSuccess, then a publicationDenied will be automatically sent after pushIt.TIMEOUTS.onPublicationRequest milliseconds

###4. An message is sent to a channel where an agent has a subscription.
### 4. An message is sent to a channel where an agent has a subscription.

Agent.onMessageReceived = function(channel, agent, message){}

Expand All @@ -116,11 +116,11 @@ Self-contained on the client. On the server, Push-It is tested with Node 0.4.7

NOTE: this callback is unlike the others. there is no timeout or failure condition. you can silently drop messages and nobody will be informed. This is useful if you want to perform some JIT transformation of messages before delivery to agents.

###5. An agent unsubscribes to channels
### 5. An agent unsubscribes to channels

This is the same as subscription, except with the names changed to Unsubscribe and Unsubscription.

###6. An agent disconnects
### 6. An agent disconnects

PushIt.onDisconnect(agent)

Expand Down