HubCategoryBehavior Protocol Reference


                    
                    
                    dispatch(to:payload:)

Dispatch a Hub message on the specified channel

Swift

func dispatch(to channel: HubChannel, payload: HubPayload)

`channel`	The channel to send the message on
`payload`	The payload to send


                    
                    
                    listen(to:eventName:listener:)

Listen to Hub messages with a particular event name on a particular channel

Swift

func listen(
    to channel: HubChannel,
    eventName: HubPayloadEventName,
    listener: @escaping HubListener
) -> UnsubscribeToken

`channel`	The channel to listen for messages on
`eventName`	Only hub payloads with this event name will be dispatched to the listener
`listener`	The closure to invoke with the received message


                    
                    
                    listen(to:isIncluded:listener:)

Listen to Hub messages on a particular channel, optionally filtering message prior to dispatching them

Swift

func listen(
    to channel: HubChannel,
    isIncluded filter: HubFilter?,
    listener: @escaping HubListener
) -> UnsubscribeToken

`channel`	The channel to listen for messages on
`filter`	If specified, candidate messages will be passed to this closure prior to dispatching to the `listener`. Only messages for which the filter returns `true` will be dispatched.
`listener`	The closure to invoke with the received message


                    
                    
                    removeListener(_:)

Removes the listener identified by token

Swift

func removeListener(_ token: UnsubscribeToken)


                                token

The UnsubscribeToken returned by listen


                    
                    
                    publisher(for:)

Extension method

Returns a publisher for all Hub messages sent to channel

Swift

public func publisher(for channel: HubChannel) -> HubPublisher


                                channel

The channel to listen for messages on