module Athena::Mercure::Hub::Interface

Overview

Represents the API that a Mercure hub instance must implement.

Direct including types

Defined in:

hub/interface.cr

Instance Method Summary

Instance Method Detail

abstract def public_url : String #

Returns the public URL of this hub used to subscribe.


[View source]
abstract def publish(update : AMC::Update) : String #

Publishes the provided update to this hub.


[View source]
abstract def token_factory : AMC::TokenFactory::Interface | Nil #

Returns the [AMC::TokenFactory::Interface][] associated with this hub.


[View source]
abstract def token_provider : AMC::TokenProvider::Interface | Nil #

Returns the [AMC::TokenProvider::Interface][] associated with this hub.


[View source]
abstract def url : String #

Returns the internal URL of this hub used to publish updates.


[View source]