This API documentation is for Ballerina 1.2.0. View API documentation for the latest release.

Records

v1.2.14

websub

All Modules

Record - websub : HubConfiguration

Record representing hub specific configurations.

Closed record

Fields

  • leaseSeconds int (default 86400)

  • The default lease seconds value to honour if not specified in subscription requests

  • signatureMethod SignatureMethod (default SHA256)

  • The signature method to use for authenticated content delivery (SHA1|SHA256)

  • remotePublish RemotePublishConfig

  • The record representing configuration related to remote publishing allowance

  • topicRegistrationRequired boolean (default true)

  • Whether a topic needs to be registered at the hub prior to publishing/subscribing to the topic

  • clientConfig ClientConfiguration

  • The configuration for the hub to communicate with remote HTTP endpoints

  • tapOnMessage function(WebSubContent) returns (())

  • The configuration for passing a function to be invoked when an update is received at the hub

  • tapOnDelivery function(string, string, WebSubContent) returns (())

  • The configuration for passing a function to be invoked when an update is successfully delivered to the subscribers

  • tapOnDeliveryFailure function(string, string, WebSubContent, Response | error, FailureReason) returns (())

  • The configuration for passing a function to be invoked when an update is failed to be delivered to the subscribers