subscription

Documentation

Index

• type EventSubscription
  • func NewEventSubscription(doUnsubscribe func()) EventSubscription

Types

type EventSubscription

type EventSubscription interface {
	Unsubscribe()
}

EventSubscription is returned by an event source as a result of operation subscribing to the given type of event. It allows to unsubscribe from the event stream at any point, by calling the `Unsubscribe` method.

func NewEventSubscription

func NewEventSubscription(doUnsubscribe func()) EventSubscription

NewEventSubscription is used by an event source to create a `EventSubscription`. It accepts a callback function that is called as a result of `Unsubscribe` operation on the `EventSubscription`. The callback function executes operation on the event source required to unsubscribe from the event stream.