...
- Pico A receives a
wrangler:subscription
event that includes the following attributes:name
- name of subscription (if none is supplied, a random subscription name will be generated)name_space
- name space for subscription (if none is suppliedshared
will be used as the name space)my_role
- Pico A's role in the subscription (if none is supplied,peer
will be used for the role)subscriber_role
- Pico B's role in the subscription (also defaults topeer
).subscriber_eci
- Pico B's well known ECI. Pico A must receive an ECI to contact Pico B. (This eci will be stored after the subscription has been accepted. Events should be sent to the outbound eci, not the original subscriber eci.)channel_type
- the channel type for Pico A's yet to be created inbound ECI (if none is supplied,subs
will be used).attrs
- the attributes for this subscription. These are used for Pico A's incoming channel's attributes. If none are supplied, the default is "status".
- Pico A sends a
wrangler:pending_subscription
event to Pico B, using the channel given by thesubscriber_eci
in step one with the following attributes:name
- name of subscription.name_space
- name space for subscription.my_role
- Pico B's role in the subscription.subscriber_role
- Pico A's role in the subscription.outbound_eci
- Pico A's newly created inbound ECI.channel_type
- the channel type for Pico B's yet to be created inbound ECI (the same as Pico A's).attributes
- the attributes for this subscription. These are used for Pico B's incoming channel's attributes.
Pico A also raises an internalwrangler:pending_subscription
event with the corresponding attributes above. - Upon receiving the
wrangler:pending_subscription
event, Pico B, creates a pending subscription (channel mentioned above) and raises thewrangler:inbound_pending_subscription_added
event. Pico A raises thewrangler:outbound_pending_subscription_added
event.
The state of each Picos subscription is static at this point. Pico A has an outgoing pending subscription and Pico B has an incoming pending subscription. - If Pico B wants to approve the subscription request, it raises the
wrangler:pending_subscription_approval
event with an attribute namedchannelsubscription_name
giving the name of the channel/subscription to approve. Upon successfully creating the subscription. Pico B:- sends the
wrangler:pending_subscription_approved
event to Pico A on Pico B'soutbound_eci
value stored in its subscription. - raises the
wrangler:subscription_added
event
- sends the
- Upon receiving the
wrangler:pending_subscription_approved
event, Pico A adds an outbound_eci to the subscription on its side and raises thewrangler:subscription_added
event. - If Pico B wants to reject the subscription, it raises the
wrangler:inbound_subscription_rejectioncancellation
event (internally) with an attribute namedchannelsubscription_name
- the name of the channel/subscription to reject. Pico B:- sends the
wrangler:subscription_removal
event to Pico A on Picos B outbound_eci, which then raises thewrangler:subscription_removed
event to itself. - raises the
wrangler:subscription_removal
event, which raises thewrangler:subscription_removed
event.
- sends the
...
Initial Subscription Flow
Subscription Approval Flow
Subscription Rejection Flow
Subscription Events
...
Returns a map from subscription names to subscription objects, or various forms of this map.
Parameter | Datatype | Required |
---|---|---|
<collectBy> | <hash path> | no |
<filterValue> | <string> | no, and don't use if <collectBy> is omitted |
getSubscriptions() with no arguments returns the entire map, e.g.
...