websocket

Documentation

Index

• func WithMaxTopicSubscriptionsPerClient(maxTopicSubscriptionsPerClient int) options.Option[Service]
• type EventHandler
  • func NewEventHandler(pub *publisher.Publisher, publishEvent *event.Event[*ISCEvent], ...) *EventHandler
  • func (p *EventHandler) AttachToEvents()
  • func (p *EventHandler) DetachEvents()
• type ISCEvent
  • func MapISCEvent[T any](iscEvent *publisher.ISCEvent[T], mappedPayload any) *ISCEvent
• type Service
  • func NewWebsocketService(log *logger.Logger, hub *websockethub.Hub, msgTypes []publisher.ISCEventType, ...) *Service
  • func (p *Service) EventHandler() *EventHandler
  • func (p *Service) ServeHTTP(c echo.Context) error
• type SubscriptionValidator
  • func NewSubscriptionValidator(messageTypes map[publisher.ISCEventType]bool, ...) *SubscriptionValidator

Functions

func WithMaxTopicSubscriptionsPerClient

func WithMaxTopicSubscriptionsPerClient(maxTopicSubscriptionsPerClient int) options.Option[Service]

Types

type EventHandler

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

func NewEventHandler

func NewEventHandler(pub *publisher.Publisher, publishEvent *event.Event[*ISCEvent], subscriptionValidator *SubscriptionValidator) *EventHandler

func (*EventHandler) AttachToEvents

func (p *EventHandler) AttachToEvents()

func (*EventHandler) DetachEvents

func (p *EventHandler) DetachEvents()

type ISCEvent

type ISCEvent struct {
	Kind      publisher.ISCEventType `json:"kind"`
	Issuer    string                 `json:"issuer"`    // (isc.AgentID) nil means issued by the VM
	RequestID string                 `json:"requestID"` // (isc.RequestID)
	ChainID   string                 `json:"chainID"`   // (isc.ChainID)
	Payload   any                    `json:"payload"`
}

func MapISCEvent

func MapISCEvent[T any](iscEvent *publisher.ISCEvent[T], mappedPayload any) *ISCEvent

type Service

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

func NewWebsocketService

func NewWebsocketService(log *logger.Logger, hub *websockethub.Hub, msgTypes []publisher.ISCEventType, pub *publisher.Publisher, opts ...options.Option[Service]) *Service

func (*Service) EventHandler

func (p *Service) EventHandler() *EventHandler

func (*Service) ServeHTTP

func (p *Service) ServeHTTP(c echo.Context) error

ServeHTTP serves the websocket.

type SubscriptionValidator

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

func NewSubscriptionValidator

func NewSubscriptionValidator(messageTypes map[publisher.ISCEventType]bool, subscriptionManager *subscriptionmanager.SubscriptionManager[websockethub.ClientID, string]) *SubscriptionValidator