centrifugo

Documentation

Index

• Constants
• func PublishStatus(ctx context.Context, ns string, s StateProvider, p Publisher) error
• type Channel
  • func ParseChannel(s, namespace string) (*Channel, error)
  • func (c *Channel) Interval() time.Duration
  • func (c *Channel) Name() string
  • func (c *Channel) String() string
• type Publisher
• type StateProvider

Constants

const ErrIgnoredChannel = channelError("channel ignored")

ErrIgnoredChannel is returned when the chennel is to be ignored.

const HeartbeatChannel = "heartbeat"

HeartbeatChannel is theCentrifugo channel name for heartbeat messages.

const NsSeparator = ":"

NsSeparator is the channel namespace boundary character.

Functions

func PublishStatus

func PublishStatus(ctx context.Context, ns string, s StateProvider, p Publisher) error

PublishStatus publishes the status of the service to Centrifugo heartbeat channel.

Types

type Channel

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

Channel represents a Centrifugo channel suitable for OPC-UA use.

func ParseChannel

func ParseChannel(s, namespace string) (*Channel, error)

ParseChannel parses a Centrifugo channel and creates a Channel structure.

See "Specifications" section in README.md for the format of the channel.

func (*Channel) Interval

func (c *Channel) Interval() time.Duration

Interval returns the channel interval.

func (*Channel) Name

func (c *Channel) Name() string

Name returns the channel name.

func (*Channel) String

func (c *Channel) String() string

String returns the string representation of the channel.

type Publisher

type Publisher interface {
	Publish(ctx context.Context, channel string, data []byte, opts ...gocent.PublishOption) (gocent.PublishResult, error)
}

Publisher is a consumer contract modelling a Centrifugo publisher.

type StateProvider

type StateProvider interface {
	State() opcua.ConnState
}

StateProvider is a consumer contract modelling an OPC-UA client.