Update pub_sub
This commit is contained in:
thomashii
parent
6371c69bfe
commit
03a2a9385c
3 changed files with 39 additions and 15 deletions
|
|
@ -1,21 +1,34 @@
|
|||
# 3.0.2
|
||||
# Change Log
|
||||
|
||||
## 3.0.3
|
||||
|
||||
* Final release. Replaced by `belatuk_pub_sub` package.
|
||||
|
||||
## 3.0.2
|
||||
|
||||
* Resolved static analysis warnings
|
||||
|
||||
# 3.0.1
|
||||
## 3.0.1
|
||||
|
||||
* Resolved static analysis warnings
|
||||
# 3.0.0
|
||||
|
||||
## 3.0.0
|
||||
|
||||
* Migrated to work with Dart SDK 2.12.x NNBD
|
||||
|
||||
# 2.3.0
|
||||
## 2.3.0
|
||||
|
||||
* Allow `2.x` versions of `stream_channel`.
|
||||
* Apply `package:pedantic` lints.
|
||||
|
||||
# 2.2.0
|
||||
## 2.2.0
|
||||
|
||||
* Upgrade `uuid`.
|
||||
|
||||
# 2.1.0
|
||||
* Allow for "trusted clients," which are implicitly-registered clients.
|
||||
This makes using `package:pub_sub` easier, as well making it easier to scale.
|
||||
## 2.1.0
|
||||
|
||||
# 2.0.0
|
||||
* Dart 2 updates.
|
||||
* Allow for "trusted clients," which are implicitly-registered clients. This makes using `package:pub_sub` easier, as well making it easier to scale.
|
||||
|
||||
## 2.0.0
|
||||
|
||||
* Dart 2 updates.
|
||||
|
|
|
|||
|
|
@ -1,13 +1,17 @@
|
|||
# angel3_pub_sub
|
||||
[](https://pub.dartlang.org/packages/angel3_pub_sub)
|
||||
# Angel3 Pub Sub
|
||||
|
||||
[](https://pub.dartlang.org/packages/angel3_pub_sub)
|
||||
[](https://dart.dev/null-safety)
|
||||
[](https://gitter.im/angel_dart/discussion)
|
||||
|
||||
[](https://github.com/dukefirehawk/angel/tree/angel3/packages/pub_sub/LICENSE)
|
||||
|
||||
**DEPRECATED: Replaced by [`belatuk_pub_sub`](https://pub.dartlang.org/packages/belatuk_pub_sub) package**
|
||||
|
||||
Keep application instances in sync with a simple pub/sub API.
|
||||
|
||||
# Installation
|
||||
|
||||
Add `angel3_pub_sub` as a dependency in your `pubspec.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
@ -18,6 +22,7 @@ dependencies:
|
|||
Then, be sure to run `pub get` in your terminal.
|
||||
|
||||
# Usage
|
||||
|
||||
`pub_sub` is your typical pub/sub API. However, `angel3_pub_sub` enforces authentication of every
|
||||
request. It is very possible that `angel3_pub_sub` will run on both servers and in the browser,
|
||||
or on a platform angel3_pub_sublike Flutter. Thus, there are provisions available to limit
|
||||
|
|
@ -46,7 +51,9 @@ main() async {
|
|||
server.start();
|
||||
}
|
||||
```
|
||||
|
||||
### Trusted Clients
|
||||
|
||||
You can use `package:angel3_pub_sub` without explicitly registering
|
||||
clients, *if and only if* those clients come from trusted sources.
|
||||
|
||||
|
|
@ -63,6 +70,7 @@ pub_sub.IsolateClient(null);
|
|||
```
|
||||
|
||||
### Access Control
|
||||
|
||||
The ID's of all *untrusted* clients who will connect to the server must be known at start-up time.
|
||||
You may not register new clients after the server has started. This is mostly a security consideration;
|
||||
if it is impossible to register new clients, then malicious users cannot grant themselves additional
|
||||
|
|
@ -89,8 +97,9 @@ main() async {
|
|||
```
|
||||
|
||||
## Isolates
|
||||
|
||||
If you are just running multiple instances of a server,
|
||||
use `package:angel3_pub_sub/isolate.dart`.
|
||||
use `package:angel3_pub_sub/isolate.dart`.
|
||||
|
||||
You'll need one isolate to be the master. Typically this is the first isolate you create.
|
||||
|
||||
|
|
@ -140,6 +149,7 @@ void isolateMain(List args) {
|
|||
```
|
||||
|
||||
## JSON RPC 2.0
|
||||
|
||||
If you are not running on isolates, you need to import
|
||||
`package:angel3_pub_sub/json_rpc_2.dart`. This library leverages `package:json_rpc_2` and
|
||||
`package:stream_channel` to create clients and servers that can hypothetically run on any
|
||||
|
|
@ -148,6 +158,7 @@ medium, i.e. WebSockets, or TCP Sockets.
|
|||
Check out `test/json_rpc_2_test.dart` for an example of serving `angel3_pub_sub` over TCP sockets.
|
||||
|
||||
# Protocol
|
||||
|
||||
`angel3_pub_sub` is built upon a simple RPC, and this package includes
|
||||
an implementation that runs via `SendPort`s and `ReceivePort`s, as
|
||||
well as one that runs on any `StreamChannel<String>`.
|
||||
|
|
@ -220,4 +231,4 @@ The client and server in `package:angel3_pub_sub/isolate.dart` must make extra
|
|||
provisions to keep track of client ID's. Since `SendPort`s and `ReceivePort`s
|
||||
do not have any sort of guaranteed-unique ID's, new clients must send their
|
||||
`SendPort` to the server before sending any requests. The server then responds
|
||||
with an `id` that must be used to identify a `SendPort` to send a response to.
|
||||
with an `id` that must be used to identify a `SendPort` to send a response to.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
name: angel3_pub_sub
|
||||
version: 3.0.2
|
||||
version: 3.0.3
|
||||
description: Keep application instances in sync with a simple pub/sub API.
|
||||
homepage: https://github.com/dukefirehawk/angel/tree/angel3/packages/pub_sub
|
||||
environment:
|
||||
|
|
|
|||
Loading…
Reference in a new issue