scope

Documentation

Index

• type Option
  • func WithPort(port int) Option
• type Scope
  • func New(ctx context.Context, opts ...Option) (*Scope, error)
  • func (s *Scope) Close()
  • func (s *Scope) Err() <-chan error
  • func (s *Scope) GenerateID() string
  • func (s *Scope) Publish(ev event.Query)
  • func (s *Scope) Subscribe() (<-chan event.Query, func())
  • func (s *Scope) SubscriberCount() int

Types

type Option

type Option func(*Scope)

Option configures a Scope.

func WithPort

func WithPort(port int) Option

WithPort sets the port for the internal gRPC server.

type Scope

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

Scope manages the lifecycle of the event broker and internal gRPC server that exposes captured query events to TUI clients.

func New

func New(ctx context.Context, opts ...Option) (*Scope, error)

New creates a new Scope and starts the internal gRPC server.

func (*Scope) Close

func (s *Scope) Close()

Close stops the internal gRPC server.

func (*Scope) Err

func (s *Scope) Err() <-chan error

Err returns a channel that receives the server's exit error. It is nil if the server is still running.

func (*Scope) GenerateID

func (s *Scope) GenerateID() string

GenerateID returns a unique sequential ID for a query event.

func (*Scope) Publish

func (s *Scope) Publish(ev event.Query)

Publish sends a query event to all connected subscribers.

func (*Scope) Subscribe

func (s *Scope) Subscribe() (<-chan event.Query, func())

Subscribe returns a channel that receives published events and an unsubscribe function.

func (*Scope) SubscriberCount

func (s *Scope) SubscriberCount() int

SubscriberCount returns the number of active Watch subscribers.