eventstream

Documentation

Overview

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

Package eventstream implements a publisher / subscriber.

************************************************** Copyright 2016 https://github.com/AsynkronIT/protoactor-go

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ****************************************************

Index

• func Publish(event interface{})
• func Unsubscribe(sub *Subscription)
• type EventStream
  • func (ps *EventStream) Publish(evt interface{})
  • func (es *EventStream) Subscribe(fn func(evt interface{})) *Subscription
  • func (ps *EventStream) Unsubscribe(sub *Subscription)
• type Predicate
• type Subscription
  • func Subscribe(fn func(evt interface{})) *Subscription
  • func (s *Subscription) WithPredicate(p Predicate) *Subscription

Functions

func Publish

func Publish(event interface{})

func Unsubscribe

func Unsubscribe(sub *Subscription)

Types

type EventStream

type EventStream struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*EventStream) Publish

func (ps *EventStream) Publish(evt interface{})

func (*EventStream) Subscribe

func (es *EventStream) Subscribe(fn func(evt interface{})) *Subscription

func (*EventStream) Unsubscribe

func (ps *EventStream) Unsubscribe(sub *Subscription)

type Predicate

type Predicate func(evt interface{}) bool

Predicate is a function used to filter messages before being forwarded to a subscriber

type Subscription

type Subscription struct {
	// contains filtered or unexported fields
}

Subscription is returned from the Subscribe function.

This value and can be passed to Unsubscribe when the observer is no longer interested in receiving messages

func Subscribe

func Subscribe(fn func(evt interface{})) *Subscription

func (*Subscription) WithPredicate

func (s *Subscription) WithPredicate(p Predicate) *Subscription

WithPredicate sets a predicate to filter messages passed to the subscriber