...
wrangler:subscription (pico A)
| Name | Default | Use |
|---|---|---|
| attrs | "status" | additional data to store for the new subscription - can be any type |
| channel_type | "subs" | describes each pico's new channel created for the subscription |
| my_role | "peer" | describes pico A (self) in the context of the subscription |
| name | string including a random English word | If a subscription with the same combination of name and namespace exists in the engine hosting pico A, the subscription won't be created. Otherwise, pico A will receive wrangler:outbound_pending_subscription_added and pico B will receive wrangler:inbound_pending_subscription_added. If pico B is hosted on a different engine and a subscription with this full name already exists there (e.g. "name_space:name"), the new subscription will be cancelled and both picos will receive wrangler:subscription_removed after the '_added' events. |
| name_space | "shared" | |
| subscriber_eci | the subscription won't be created | the subscription process needs one of pico B's existing eci's |
| subscriber_host | none | the public DNS name of the engine hosting pico B (only needed if different from pico A's) - e.g. "https://localhost:8080" |
| subscriber_role | "peer" | describes pico B in the context of the subscription |
wrangler:outbound_subscription_cancellation,
wrangler:inbound_subscription_rejection,
wrangler:subscription_cancellation
| Name | Default | Use |
|---|---|---|
| subscription_name | no subscription cancelled | the full name of the subscription to cancel - both picos will receive wrangler:subscription_removed |
wrangler:pending_subscription_approval (pico B)
| Name | Default | Use |
|---|---|---|
| subscription_name | no subscription approved | the full name of the pending subscription to approve - both picos will receive wrangler:subscription_added |
wrangler:outbound_pending_subscription_added (pico A)
| Name | Value |
|---|---|
| attributes | defined in wrangler:subscription |
| channel_name | full subscription name(e.g. "name_space:name") |
| channel_type | defined in wrangler:subscription |
| inbound_eci | pico A's new eci created for the subscription |
| my_role | defined in wrangler:subscription |
| name | defined in wrangler:subscription |
| name_space | defined in wrangler:subscription |
| relationship | string of the form my_role+"<->"+subscriber_role |
| status | "outbound" |
| subscriber_eci | defined in wrangler:subscription |
| subscriber_host (only included if the picos are hosted on different engines) | defined in wrangler:subscription |
| subscriber_role | defined in wrangler:subscription |
example value of getSubscriptions(){channel_name}:
...
wrangler:inbound_pending_subscription_added (pico B)
| Name | Value |
|---|---|
attributes | defined in wrangler:subscription |
| channel_name | full subscription name(e.g. "name_space:name") |
| channel_type | defined in wrangler:subscription |
| my_role | subscriber_role in wrangler:subscription |
| name | defined in wrangler:subscription |
| name_space | defined in wrangler:subscription |
| outbound_eci | pico A's new eci created for the subscription |
| relationship | string of the form my_role+"<->"+subscriber_role |
| status | "inbound" |
| subscriber_host (only included if the picos are hosted on different engines) | public DNS name of the engine hosting pico A |
| subscriber_role | my_role in wrangler:subscription |
example value of getSubscriptions(){channel_name}:
...
wrangler:subscription_removed
| Name | Value |
|---|---|
| removed_subscription | the value of getSubscriptions(){full subscription name} before it was removed |
wrangler:subscription_added
| Name | Value |
|---|---|
| channel_name | full subscription name(e.g. "name_space:name") |
example value of getSubscriptions(){channel_name}: (pico A)
...