commands

Documentation

Index

• Variables
• type BaseCommand
• type BaseEvent
• type CommandHandler
• type CommandManager
  • func NewCommandHandler(log *logger.Logger, ...) *CommandManager
  • func (c *CommandManager) HandleNodeCommands(client *websockethub.Client, message []byte) error
• type CommandType
• type EventType
• type SubscriptionCommand
• type SubscriptionCommandHandler
  • func (s *SubscriptionCommandHandler) HandleCommand(client *websockethub.Client, message []byte) error
  • func (s *SubscriptionCommandHandler) SupportsCommand(commandType CommandType) bool
• type SubscriptionEvent

Variables

var (
	ErrFailedToDeserializeCommand = errors.New("failed to deserialize command")
	ErrFailedToValidateCommand    = errors.New("failed to validate command")
	ErrFailedToSendMessage        = errors.New("failed to send message")
)

Types

type BaseCommand

type BaseCommand struct {
	Command CommandType `json:"command"`
}

type BaseEvent

type BaseEvent struct {
	Event EventType `json:"event"`
}

type CommandHandler

type CommandHandler interface {
	SupportsCommand(commandType CommandType) bool
	HandleCommand(client *websockethub.Client, message []byte) error
}

type CommandManager

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

func NewCommandHandler

func NewCommandHandler(log *logger.Logger, subscriptionManager *subscriptionmanager.SubscriptionManager[websockethub.ClientID, string]) *CommandManager

func (*CommandManager) HandleNodeCommands

func (c *CommandManager) HandleNodeCommands(client *websockethub.Client, message []byte) error

type CommandType

type CommandType string

const (
	CommandSubscribe   CommandType = "subscribe"
	CommandUnsubscribe CommandType = "unsubscribe"
)

type EventType

type EventType string

const (
	EventClientWasSubscribed   EventType = "subscribed"
	EventClientWasUnsubscribed EventType = "unsubscribed"
)

type SubscriptionCommand

type SubscriptionCommand struct {
	BaseCommand
	Topic string `json:"topic"`
}

type SubscriptionCommandHandler

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

func (*SubscriptionCommandHandler) HandleCommand

func (s *SubscriptionCommandHandler) HandleCommand(client *websockethub.Client, message []byte) error

func (*SubscriptionCommandHandler) SupportsCommand

func (s *SubscriptionCommandHandler) SupportsCommand(commandType CommandType) bool

type SubscriptionEvent

type SubscriptionEvent struct {
	BaseEvent
	Topic string `json:"topic"`
}