subscribe

Documentation

Overview

Package subscribe manages subscriptions to all or specific go structs.

Index

• type SubscribeManager
  • func New() *SubscribeManager
  • func (s *SubscribeManager) HandleStruct(p any)
  • func (s *SubscribeManager) SubscribeToAllStructs(callback any) (SubscriptionId, error)
  • func (s *SubscribeManager) SubscribeToStruct(t any, callback any) (SubscriptionId, error)
  • func (s *SubscribeManager) Unsubscribe(subId SubscriptionId) error
• type SubscriptionId

Types

type SubscribeManager

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

SubscribeManager maintains lists of subscribers to specific or all structs.

func New

func New() *SubscribeManager

New returns a pointer to a new SubscribeManager.

func (*SubscribeManager) HandleStruct

func (s *SubscribeManager) HandleStruct(p any)

HandleStruct calls registered subscriber callbacks for a struct. It calls all specific subscribers and all subscribers.

func (*SubscribeManager) SubscribeToAllStructs

func (s *SubscribeManager) SubscribeToAllStructs(callback any) (SubscriptionId, error)

SubscribeToAllStructs registers a subscription to all structs. It validates the callback is a func with an any argument.

func (*SubscribeManager) SubscribeToStruct

func (s *SubscribeManager) SubscribeToStruct(t any, callback any) (SubscriptionId, error)

SubscribeToStruct registers a subscription to the specified struct. It validates the callback is a function with a matching argument type.

func (*SubscribeManager) Unsubscribe

func (s *SubscribeManager) Unsubscribe(subId SubscriptionId) error

Unsubscribe cancels a subscription.

type SubscriptionId

type SubscriptionId uint

SubscriptionId identifies a specific subscriber.