Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Seperate getSubscriptions and unimplemented function notes

...

Subscription Rejection Flow

Subscription Events

Info

This section mentions getSubscriptions(), which is provided by the Subscriptions ruleset and returns a map from all subscription names to subscription objects.

Overview

Event Domain

Event Type

Actions

Use

wranglersubscription

creates outbound pending subscription and sends pending_subscription event to external pico

Creates a new outbound pending subscription
wranglerpending_subscriptioncreates inbound pending subscriptionCreates a new inbound pending subscription
wranglerpending_subscription_approvalsends pending_subscription_approved event with inbound_eci and outbound status to external pico and raises pending_subscription_approved with inbound statusAprove inbound pending subscription
wranglerpending_subscription_approvedupdates subscription status and outbound_eci if neededInternally for adding aproved subscriptions
wrangler

subscription_cancellation |

inbound_subscription_rejection |

outbound_subscription_cancellation

sends subscription_removal event with eci and status and raise the same event to selfalert external pico to remove subscriptions and alert self to remove subscription
wranglersubscription_removaldeletes channel used for subscriptioninternally for removing channel used for subscription

...

NameValue

attributes

attrs in wrangler:subscription
channel_namefull subscription name(e.g. "name_space:name")
channel_typedefined in wrangler:subscription
my_rolesubscriber_role in wrangler:subscription
namedefined in wrangler:subscription
name_spacedefined in wrangler:subscription
outbound_ecipico A's new eci created for the subscription
relationshipstring 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_rolemy_role in wrangler:subscription

...

Info

The following subscription functions are not yet implemented. A getSubscriptions function is available, which takes no arguments and returns an unfiltered map in the form documented below for subscriptions().


Function
Use
subscriptionsList a set of subscriptions depending on what parameters are given.
subscriptionAttributesLists a subscription's attributes
checkSubscriptionNameChecks if a subscription's name exists

...