webnotifier

Documentation

Index

• func PrepareTopicMessage(topic string, message []byte) ([]byte, error)
• type Action
• type HTTPNotifier
  • func NewHTTPNotifier(webhookURLs []string) *HTTPNotifier
  • func (n *HTTPNotifier) Notify(topic string, message []byte) error
• type Notifier
• type Observer
  • func NewObserver(notifier Notifier) *Observer
  • func (o *Observer) RegisterAction(topic string, ch <-chan service.DIDCommAction)
  • func (o *Observer) RegisterStateMsg(topic string, ch <-chan service.StateMsg)
• type StateMsg
• type WSNotifier
  • func NewWSNotifier(path string) *WSNotifier
  • func (n *WSNotifier) GetRESTHandlers() []rest.Handler
  • func (n *WSNotifier) Notify(topic string, message []byte) error
• type WebNotifier
  • func New(wsPath string, webhookURLs []string) *WebNotifier
  • func (n *WebNotifier) GetRESTHandlers() []rest.Handler
  • func (n *WebNotifier) Notify(topic string, message []byte) error

Functions

func PrepareTopicMessage

func PrepareTopicMessage(topic string, message []byte) ([]byte, error)

PrepareTopicMessage prepares topic message.

Types

type Action

type Action struct {
	ProtocolName string                 `json:",omitempty"`
	Message      service.DIDCommMsgMap  `json:",omitempty"`
	Properties   map[string]interface{} `json:",omitempty"`
}

Action represents service.DIDCommAction.

type HTTPNotifier

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

HTTPNotifier is a webhook dispatcher capable of notifying multiple subscribers via HTTP.

func NewHTTPNotifier

func NewHTTPNotifier(webhookURLs []string) *HTTPNotifier

NewHTTPNotifier returns a new instance of an HTTPNotifier.

func (*HTTPNotifier) Notify

func (n *HTTPNotifier) Notify(topic string, message []byte) error

Notify sends the given message to all of the urls. Topic is appended to the end of the webhook (subscriber) URL. E.g. localhost:8080/topic If multiple errors are encountered, then the first one is returned.

type Notifier

type Notifier interface {
	Notify(topic string, message []byte) error
}

Notifier represents a notification dispatcher.

type Observer

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

Observer instance.

func NewObserver

func NewObserver(notifier Notifier) *Observer

NewObserver returns observer.

func (*Observer) RegisterAction

func (o *Observer) RegisterAction(topic string, ch <-chan service.DIDCommAction)

RegisterAction registers action channel to observer events.

func (*Observer) RegisterStateMsg

func (o *Observer) RegisterStateMsg(topic string, ch <-chan service.StateMsg)

RegisterStateMsg registers state channel to observer events.

type StateMsg

type StateMsg struct {
	ProtocolName string                 `json:",omitempty"`
	Type         string                 `json:",omitempty"`
	StateID      string                 `json:",omitempty"`
	Message      service.DIDCommMsgMap  `json:",omitempty"`
	Properties   map[string]interface{} `json:",omitempty"`
}

StateMsg represents service.StateMsg.

type WSNotifier

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

WSNotifier is a dispatcher capable of notifying multiple subscribers via WebSocket.

func NewWSNotifier

func NewWSNotifier(path string) *WSNotifier

NewWSNotifier returns a new instance of an WSNotifier.

func (*WSNotifier) GetRESTHandlers

func (n *WSNotifier) GetRESTHandlers() []rest.Handler

GetRESTHandlers returns all REST handlers provided by notifier.

func (*WSNotifier) Notify

func (n *WSNotifier) Notify(topic string, message []byte) error

Notify sends the given message to all of the WS clients. If multiple errors are encountered, then the first one is returned.

type WebNotifier

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

WebNotifier is a dispatcher capable of notifying multiple subscribers via HTTP Webhooks and WebSockets.

func New

func New(wsPath string, webhookURLs []string) *WebNotifier

New returns a new instance of a WebNotifier.

func (*WebNotifier) GetRESTHandlers

func (n *WebNotifier) GetRESTHandlers() []rest.Handler

GetRESTHandlers returns all REST handlers provided by notifier.

func (*WebNotifier) Notify

func (n *WebNotifier) Notify(topic string, message []byte) error

Notify sends the given message to all of the subscribers. If multiple errors are encountered, then the first one is returned.