broadcaster

Documentation

Index

• Constants
• type Broadcaster
  • func NewBroadcaster(c chan SocketData) *Broadcaster
  • func (b *Broadcaster) Expired() bool
  • func (b *Broadcaster) PoolSize() (size int)
  • func (b *Broadcaster) Subscribe() (*Subscriber, error)
  • func (b *Broadcaster) Unsubscribe(sub *Subscriber) error
• type SocketData
• type Subscriber
  • func (s *Subscriber) SubChan() <-chan SocketData
  • func (s *Subscriber) UnsubChan() <-chan struct{}

Constants

const (
	Log                     messageType = "Log"
	NamespaceCreated        messageType = "NamespaceCreated"
	NamespaceDeleted        messageType = "NamespaceDeleted"
	PipelineCreated         messageType = "PipelineCreated"
	PipelineDeleted         messageType = "PipelineDeleted"
	PipelineUpdated         messageType = "PipelineUpdated"
	ClusterTaskCreated      messageType = "ClusterTaskCreated"
	ClusterTaskDeleted      messageType = "ClusterTaskDeleted"
	ClusterTaskUpdated      messageType = "ClusterTaskUpdated"
	TaskCreated             messageType = "TaskCreated"
	TaskDeleted             messageType = "TaskDeleted"
	TaskUpdated             messageType = "TaskUpdated"
	PipelineResourceCreated messageType = "PipelineResourceCreated"
	PipelineResourceDeleted messageType = "PipelineResourceDeleted"
	PipelineResourceUpdated messageType = "PipelineResourceUpdated"
	PipelineRunCreated      messageType = "PipelineRunCreated"
	PipelineRunDeleted      messageType = "PipelineRunDeleted"
	PipelineRunUpdated      messageType = "PipelineRunUpdated"
	TaskRunCreated          messageType = "TaskRunCreated"
	TaskRunDeleted          messageType = "TaskRunDeleted"
	TaskRunUpdated          messageType = "TaskRunUpdated"
	ExtensionCreated        messageType = "ExtensionCreated"
	ExtensionUpdated        messageType = "ExtensionUpdated"
	ExtensionDeleted        messageType = "ExtensionDeleted"
	SecretCreated           messageType = "SecretCreated"
	SecretDeleted           messageType = "SecretDeleted"
	SecretUpdated           messageType = "SecretUpdated"
)

Reference outside of package

Types

type Broadcaster

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

Only a pointer to the struct should be used

func NewBroadcaster

func NewBroadcaster(c chan SocketData) *Broadcaster

Creates broadcaster from channel parameter and immediately starts broadcasting Without any subscribers, received data will be discarded Broadcaster should be the only channel reader

func (*Broadcaster) Expired

func (b *Broadcaster) Expired() bool

func (*Broadcaster) PoolSize

func (b *Broadcaster) PoolSize() (size int)

Iterates over sync.Map and returns number of elements Response can be oversized if counted subscriptions are cancelled while counting

func (*Broadcaster) Subscribe

func (b *Broadcaster) Subscribe() (*Subscriber, error)

Subscriber expected to constantly consume or unsubscribe

func (*Broadcaster) Unsubscribe

func (b *Broadcaster) Unsubscribe(sub *Subscriber) error

type SocketData

type SocketData struct {
	MessageType messageType
	Payload     interface{}
}

type Subscriber

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

Wrapper return type for subscriptions

func (*Subscriber) SubChan

func (s *Subscriber) SubChan() <-chan SocketData

Read-Only access to the subscription channel Open or nil, never closed

func (*Subscriber) UnsubChan

func (s *Subscriber) UnsubChan() <-chan struct{}

Closed on unsubscribe or when broadcast parent channel closes