nc

Documentation

Overview

Package nc provides a MQTT client to connect to the Notification Centre server. MQTT could be viewed as an application layer version of TCP since it uses similar mechanisms to ensure message delivery.

Index

• Variables
• type AcknowledgementPayload
• type ActionPayload
• type AttributePayload
• type CalculateRetryDelayForAttempt
• type Client
  • func NewClient(clientBuilder ClientBuilder, subjectInfo events.Publisher[string], ...) *Client
  • func (c *Client) Revoke() bool
  • func (c *Client) Start() error
  • func (c *Client) Stop() error
• type ClientBuilder
• type ConfirmationPayload
• type CredentialsGetter
  • func NewCredsFetcher(api core.CredentialsAPI, cm config.Manager) CredentialsGetter
  • func (cf *CredentialsGetter) GetCredentialsFromAPI() (config.NCData, error)
  • func (cf *CredentialsGetter) GetCredentialsFromConfig() (config.NCData, error)
  • func (cf *CredentialsGetter) RevokeCredentials(purgeSession bool) (bool, error)
• type DataPayload
• type EventPayload
• type MessagePayload
• type MetadataPayload
• type MqttClientBuilder
  • func (MqttClientBuilder) Build(opts *mqtt.ClientOptions) mqtt.Client
• type NotificationClient
• type NotificationPayload
• type RecPayload

Variables

var ErrInvalidCredentials = fmt.Errorf("stored credentials are not valid")

Types

type AcknowledgementPayload

type AcknowledgementPayload struct {
	MessageID  string `json:"message_id"`
	TrackType  string `json:"track_type"`
	ActionSlug string `json:"action_slug"`
}

type ActionPayload

type ActionPayload struct {
	Name string `json:"name"`
	URL  string `json:"url"`
	Slug string `json:"slug"`
}

type AttributePayload

type AttributePayload struct {
	InviteeID        string   `json:"invitee_id"`
	ServerID         int      `json:"server_id"`
	ServerIP         string   `json:"server_ip"`
	AffectedMachines []string `json:"affected_machines"`
}

type CalculateRetryDelayForAttempt

type CalculateRetryDelayForAttempt func(attempt int) time.Duration

type Client

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

Client is a client for Notification center

func NewClient

func NewClient(
	clientBuilder ClientBuilder,
	subjectInfo events.Publisher[string],
	subjectErr events.Publisher[error],
	subjectPeerUpdate events.Publisher[[]string],
	credsFetcher CredentialsGetter,
) *Client

NewClient is a constructor for a NC client

func (*Client) Revoke

func (c *Client) Revoke() bool

Revoke revokes the NC communication token

func (*Client) Start

func (c *Client) Start() error

Start initiates the connection with the NC server and subscribes to mandatory topics

func (*Client) Stop

func (c *Client) Stop() error

Stop unsubscribes the topics and drops a connection with the NC server

type ClientBuilder

type ClientBuilder interface {
	Build(opts *mqtt.ClientOptions) mqtt.Client
}

type ConfirmationPayload

type ConfirmationPayload struct {
	MessageID string `json:"message_id"`
}

type CredentialsGetter

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

func NewCredsFetcher

func NewCredsFetcher(api core.CredentialsAPI, cm config.Manager) CredentialsGetter

func (*CredentialsGetter) GetCredentialsFromAPI

func (cf *CredentialsGetter) GetCredentialsFromAPI() (config.NCData, error)

GetCredentials fetches credentials from core API and saves them in local config

func (*CredentialsGetter) GetCredentialsFromConfig

func (cf *CredentialsGetter) GetCredentialsFromConfig() (config.NCData, error)

GetCredentialsFromConfig loads credentials from local config

func (*CredentialsGetter) RevokeCredentials

func (cf *CredentialsGetter) RevokeCredentials(purgeSession bool) (bool, error)

RevokeCredentials revokes credentials

type DataPayload

type DataPayload struct {
	Event    EventPayload    `json:"event"`
	Metadata MetadataPayload `json:"metadata"`
}

type EventPayload

type EventPayload struct {
	Type       string           `json:"type"`
	Attributes AttributePayload `json:"attributes"`
}

type MessagePayload

type MessagePayload struct {
	Data         DataPayload         `json:"data"`
	Notification NotificationPayload `json:"notification"`
}

type MetadataPayload

type MetadataPayload struct {
	Acked     bool   `json:"acked"`
	CreatedAt int    `json:"created_at"`
	MessageID string `json:"message_id"`
	TargetUID string `json:"target_uid"`
}

type MqttClientBuilder

type MqttClientBuilder struct{}

func (MqttClientBuilder) Build

func (MqttClientBuilder) Build(opts *mqtt.ClientOptions) mqtt.Client

type NotificationClient

type NotificationClient interface {
	Start() error
	Stop() error
	Revoke() bool
}

type NotificationPayload

type NotificationPayload struct {
	Title   string          `json:"title"`
	Body    string          `json:"body"`
	Actions []ActionPayload `json:"actions"`
}

type RecPayload

type RecPayload struct {
	Message MessagePayload `json:"message"`
}

RecPayload defines a payload sent by a NC