Skip to content

Commit

Permalink
Use pre_*_requested events on MQlobberServer
Browse files Browse the repository at this point in the history 
Means apps can continue to use non-pre_ versions
  • Loading branch information
@davedoesdev
davedoesdev committed Sep 17, 2016
1 parent 227f754 commit 330a3d6
Show file tree
Hide file tree
Showing 10 changed files with 301 additions and 323 deletions.
79 changes: 16 additions & 63 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -205,10 +205,9 @@ Coveralls page is [here](https://coveralls.io/r/davedoesdev/mqlobber-access-cont
- <a name="toc_accesscontrolprototyperesetoptions"></a><a name="toc_accesscontrolprototype"></a>[AccessControl.prototype.reset](#accesscontrolprototyperesetoptions)
- <a name="toc_accesscontrolprototypeattachserver"></a>[AccessControl.prototype.attach](#accesscontrolprototypeattachserver)
- <a name="toc_accesscontrolprototypedetachserver"></a>[AccessControl.prototype.detach](#accesscontrolprototypedetachserver)
- <a name="toc_accesscontroleventssubscribe_blockedtopic"></a><a name="toc_accesscontrolevents"></a>[AccessControl.events.subscribe_blocked](#accesscontroleventssubscribe_blockedtopic)
- <a name="toc_accesscontroleventspublish_blocked"></a>[AccessControl.events.publish_blocked](#accesscontroleventspublish_blocked)
- <a name="toc_accesscontroleventssubscribe_requestedserver-topic-cb"></a>[AccessControl.events.subscribe_requested](#accesscontroleventssubscribe_requestedserver-topic-cb)
- <a name="toc_accesscontroleventspublish_requestedserver-topic-stream-options-cb"></a>[AccessControl.events.publish_requested](#accesscontroleventspublish_requestedserver-topic-stream-options-cb)
- <a name="toc_accesscontroleventssubscribe_blockedtopic-server"></a><a name="toc_accesscontrolevents"></a>[AccessControl.events.subscribe_blocked](#accesscontroleventssubscribe_blockedtopic-server)
- <a name="toc_accesscontroleventspublish_blockedtopic-server"></a>[AccessControl.events.publish_blocked](#accesscontroleventspublish_blockedtopic-server)
- <a name="toc_accesscontroleventsmessage_blockedtopic-server"></a>[AccessControl.events.message_blocked](#accesscontroleventsmessage_blockedtopic-server)
## AccessControl(options)
Expand Down Expand Up @@ -276,7 +275,7 @@ a time. Trying to attach more than one will throw an exception.
**Parameters:**
- `{MQlobberServer} server` Object to which to apply access control. The object's [`subscribe_requested`](https://github.com/davedoesdev/mqlobber#mqlobberservereventssubscribe_requestedtopic-cb) and [`publish_requested`](https://github.com/davedoesdev/mqlobber#mqlobberservereventspublish_requestedtopic-stream-options-cb) events will be handled in order to allow or disallow client requests according to the topic specifiers passed to [`AccessControl`](#accesscontroloptions) or[`reset`](#accesscontrolprototyperesetoptions). For blocking messages delivered to clients, a [`QlobberFSQ`](https://github.com/davedoesdev/qlobber-fsq#qlobberfsqoptions) `filter` function is installed on the server's file system queue.
- `{MQlobberServer} server` Object to which to apply access control.
<sub>Go: [TOC](#tableofcontents) | [AccessControl.prototype](#toc_accesscontrolprototype)</sub>
Expand All @@ -292,7 +291,7 @@ a time. Trying to attach more than one will throw an exception.
<a name="accesscontrolevents"></a>
## AccessControl.events.subscribe_blocked(topic)
## AccessControl.events.subscribe_blocked(topic, server)
> `subscribe_blocked` event
Expand All @@ -301,82 +300,36 @@ client.
**Parameters:**
- `{String} topic` Topic that was blocked.
- `{String} topic` The topic that was blocked.
- `{MQlobberServer} server` The [`MQlobberServer`](https://github.com/davedoesdev/mqlobber#mqlobberserverfsq-stream-options) object which received the subscription request.
<sub>Go: [TOC](#tableofcontents) | [AccessControl.events](#toc_accesscontrolevents)</sub>
## AccessControl.events.publish_blocked()
## AccessControl.events.publish_blocked(topic, server)
> `publish_blocked` event
Emitted by an `AccessControl` object after it blocks a publish request from a
client.
<sub>Go: [TOC](#tableofcontents) | [AccessControl.events](#toc_accesscontrolevents)</sub>
## AccessControl.events.subscribe_requested(server, topic, cb)
> `subscribe_requested` event
Emitted by an `AccessControl` object when an attached `MQlobberServer` object
receives a request from its peer `MQlobberClient` object to subscribe to
messages published to a topic.
If there are no listeners on this event, the default action is to call
[`server.subscribe(topic, cb)`](https://github.com/davedoesdev/mqlobber#mqlobberserverprototypesubscribetopic-cb).
If you add a listener on this event, the default action will _not_ be called.
This gives you the opportunity to filter subscription requests in the
application.
Please see the documentation for [`MQlobberServer.events.subscribe_requested`](https://github.com/davedoesdev/mqlobber#mqlobberservereventssubscribe_requestedtopic-cb). There is one extra parameter here, `server`, which is the `MQlobberServer` object.
**Parameters:**
- `{MQlobberServer} server` The [`MQlobberServer`](https://github.com/davedoesdev/mqlobber#mqlobberserverfsq-stream-options) object which received the subscription request.
- `{String} topic` The topic to which the client is asking to subscribe.
- `{Function} cb` Function to call after processing the subscription request. This function _must_ be called even if you don't call
[`server.subscribe`](https://github.com/davedoesdev/mqlobber#mqlobberserverprototypesubscribetopic-cb) yourself.
It takes a single argument:
- `{Object} err` If `null` then a success status is returned to the client
(whether you called [`server.subscribe`](https://github.com/davedoesdev/mqlobber#mqlobberserverprototypesubscribetopic-cb) or not).
Otherwise, the client gets a failed status and a [`warning`](https://github.com/davedoesdev/mqlobber#mqlobberservereventswarningerr-obj) event is emitted with `err`.
- `{String} topic` The topic that was blocked.
- `{MQlobberServer} server` The [`MQlobberServer`](https://github.com/davedoesdev/mqlobber#mqlobberserverfsq-stream-options) object which received the publication request.
<sub>Go: [TOC](#tableofcontents) | [AccessControl.events](#toc_accesscontrolevents)</sub>
## AccessControl.events.publish_requested(server, topic, stream, options, cb)
> `publish_requested` event
## AccessControl.events.message_blocked(topic, server)
Emitted by an `AccessControl` object when an attached `MQlobberServer` object
receives a requests from its peer `MQlobberClient` object to publish a message
to a topic.
> `message_blocked` event
If there are no listeners on this event, the default action is to call
`stream.pipe(server.fsq.publish(topic, options, cb))`
Please see the documentation for [`MQlobberServer.events.publish_requested`](https://github.com/davedoesdev/mqlobber#mqlobberservereventspublish_requestedtopic-stream-options-cb). There is one extra parameter here, `server`, which is the `MQlobberServer` object.
Emitted by an `AccessControl` object after it blocks a message being sent to a
client.
**Parameters:**
- `{MQlobberServer} server` The [`MQlobberServer`](https://github.com/davedoesdev/mqlobber#mqlobberserverfsq-stream-options) object which received the publication request.
- `{String} topic` The topic to which the message should be published.
- `{Readable} stream` The message data as a [`Readable`](https://nodejs.org/d ist/latest-v4.x/docs/api/stream.html#stream_class_stream_readable).
- `{Object} options` Optional settings for this publication:
- `{Boolean} single` If `true` then the message should be published to
_at most_ one client (across all servers). Otherwise, it should be published
to all interested clients.
- `{Integer} ttl` Time-to-live (in seconds) for this message.
- `{Function} cb` Function to call after processing the publication request. This function _must_ be called even if you don't call
[`server.fsq.publish`](https://github.com/davedoesdev/qlobber-fsq#qlobberfsqprototypepublishtopic-payload-options-cb) yourself. It takes a single
argument:
- `{Object} err` If `null` then a success status is returned to the client
(whether you called [`server.fsq.publish`](https://github.com/davedoesdev/qlobber-fsq#qlobberfsqprototypepublishtopic-payload-options-cb) or not).
Otherwise, the client gets a failed status and a [`warning`](https://github.com/davedoesdev/mqlobber#mqlobberservereventswarningerr-obj) event is emitted with `err`.
- `{String} topic` The topic that was blocked.
- `{MQlobberServer} server` The [`MQlobberServer`](https://github.com/davedoesdev/mqlobber#mqlobberserverfsq-stream-options) object which was handling the message.
<sub>Go: [TOC](#tableofcontents) | [AccessControl.events](#toc_accesscontrolevents)</sub>
Expand Down
2 changes: 1 addition & 1 deletion coverage/coverage.json
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions coverage/lcov-report/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h1>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Branches</span>
<span class='fraction'>36/36</span>
<span class='fraction'>40/40</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
Expand Down Expand Up @@ -64,7 +64,7 @@ <h1>
<td data-value="100" class="pct high">100%</td>
<td data-value="86" class="abs high">86/86</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="36" class="abs high">36/36</td>
<td data-value="40" class="abs high">40/40</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="11" class="abs high">11/11</td>
<td data-value="100" class="pct high">100%</td>
Expand All @@ -77,7 +77,7 @@ <h1>
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage
generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Sep 13 2016 08:39:00 GMT+0100 (BST)
generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Sat Sep 17 2016 07:14:52 GMT+0100 (BST)
</div>
</div>
<script src="prettify.js"></script>
Expand Down
6 changes: 3 additions & 3 deletions coverage/lcov-report/mqlobber-access-control/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h1>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Branches</span>
<span class='fraction'>36/36</span>
<span class='fraction'>40/40</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
Expand Down Expand Up @@ -64,7 +64,7 @@ <h1>
<td data-value="100" class="pct high">100%</td>
<td data-value="86" class="abs high">86/86</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="36" class="abs high">36/36</td>
<td data-value="40" class="abs high">40/40</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="11" class="abs high">11/11</td>
<td data-value="100" class="pct high">100%</td>
Expand All @@ -77,7 +77,7 @@ <h1>
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage
generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Sep 13 2016 08:39:00 GMT+0100 (BST)
generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Sat Sep 17 2016 07:14:52 GMT+0100 (BST)
</div>
</div>
<script src="../prettify.js"></script>
Expand Down
Loading

0 comments on commit 330a3d6

Please sign in to comment.