mrpastewart/platform
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update pub_sub

Browse source
This commit is contained in:
thomashii 2021-09-12 13:04:10 +08:00
parent 6371c69bfe
commit 03a2a9385c
3 changed files with 39 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
packages/pub_sub/CHANGELOG.md
View file

@ -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 * Resolved static analysis warnings
# 3.0.1 ## 3.0.1
* Resolved static analysis warnings * Resolved static analysis warnings
# 3.0.0
## 3.0.0
* Migrated to work with Dart SDK 2.12.x NNBD * Migrated to work with Dart SDK 2.12.x NNBD
# 2.3.0 ## 2.3.0
* Allow `2.x` versions of `stream_channel`. * Allow `2.x` versions of `stream_channel`.
* Apply `package:pedantic` lints. * Apply `package:pedantic` lints.
# 2.2.0 ## 2.2.0
* Upgrade `uuid`. * Upgrade `uuid`.
# 2.1.0 ## 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.0.0 * Allow for "trusted clients," which are implicitly-registered clients. This makes using `package:pub_sub` easier, as well making it easier to scale.
* Dart 2 updates.
## 2.0.0
* Dart 2 updates.

19
packages/pub_sub/README.md
View file

@ -1,13 +1,17 @@
# angel3_pub_sub # Angel3 Pub Sub
[![version](https://img.shields.io/badge/pub-v3.0.2-brightgreen)](https://pub.dartlang.org/packages/angel3_pub_sub)
[![version](https://img.shields.io/badge/pub-v3.0.3-brightgreen)](https://pub.dartlang.org/packages/angel3_pub_sub)
[![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety) [![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety)
[![Gitter](https://img.shields.io/gitter/room/angel_dart/discussion)](https://gitter.im/angel_dart/discussion) [![Gitter](https://img.shields.io/gitter/room/angel_dart/discussion)](https://gitter.im/angel_dart/discussion)
[![License](https://img.shields.io/github/license/dukefirehawk/angel)](https://github.com/dukefirehawk/angel/tree/angel3/packages/pub_sub/LICENSE) [![License](https://img.shields.io/github/license/dukefirehawk/angel)](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. Keep application instances in sync with a simple pub/sub API.
# Installation # Installation
Add `angel3_pub_sub` as a dependency in your `pubspec.yaml` file: Add `angel3_pub_sub` as a dependency in your `pubspec.yaml` file:
```yaml ```yaml
@ -18,6 +22,7 @@ dependencies:
Then, be sure to run `pub get` in your terminal. Then, be sure to run `pub get` in your terminal.
# Usage # Usage
`pub_sub` is your typical pub/sub API. However, `angel3_pub_sub` enforces authentication of every `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, 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 or on a platform angel3_pub_sublike Flutter. Thus, there are provisions available to limit
@ -46,7 +51,9 @@ main() async {
server.start(); server.start();
} }
``` ```
### Trusted Clients ### Trusted Clients
You can use `package:angel3_pub_sub` without explicitly registering You can use `package:angel3_pub_sub` without explicitly registering
clients, *if and only if* those clients come from trusted sources. clients, *if and only if* those clients come from trusted sources.
@ -63,6 +70,7 @@ pub_sub.IsolateClient(null);
``` ```
### Access Control ### Access Control
The ID's of all *untrusted* clients who will connect to the server must be known at start-up time. 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; 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 if it is impossible to register new clients, then malicious users cannot grant themselves additional
@ -89,8 +97,9 @@ main() async {
``` ```
## Isolates ## Isolates
If you are just running multiple instances of a server, 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. 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 ## JSON RPC 2.0
If you are not running on isolates, you need to import 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: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 `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. Check out `test/json_rpc_2_test.dart` for an example of serving `angel3_pub_sub` over TCP sockets.
# Protocol # Protocol
`angel3_pub_sub` is built upon a simple RPC, and this package includes `angel3_pub_sub` is built upon a simple RPC, and this package includes
an implementation that runs via `SendPort`s and `ReceivePort`s, as an implementation that runs via `SendPort`s and `ReceivePort`s, as
well as one that runs on any `StreamChannel<String>`. 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 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 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 `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.

2
packages/pub_sub/pubspec.yaml
View file

@ -1,5 +1,5 @@
name: angel3_pub_sub name: angel3_pub_sub
version: 3.0.2 version: 3.0.3
description: Keep application instances in sync with a simple pub/sub API. description: Keep application instances in sync with a simple pub/sub API.
homepage: https://github.com/dukefirehawk/angel/tree/angel3/packages/pub_sub homepage: https://github.com/dukefirehawk/angel/tree/angel3/packages/pub_sub
environment: environment: