api

Documentation

Index

• type OpenSergoClient
• type SubscribeOption
  • func WithAttachment(key string, value interface{}) SubscribeOption
  • func WithSubscriber(subscriber subscribe.Subscriber) SubscribeOption
• type SubscribeOptions

Types

type OpenSergoClient

type OpenSergoClient interface {
	// Start the client.
	Start() error
	// SubscribeConfig subscribes data for given subscribe target.
	SubscribeConfig(key model.SubscribeKey, opts ...SubscribeOption) error
	// UnsubscribeConfig unsubscribes data for given subscribe target.
	UnsubscribeConfig(subscribeKey model.SubscribeKey) error
}

OpenSergoClient is the universal interface of OpenSergo client.

type SubscribeOption

type SubscribeOption func(*SubscribeOptions)

func WithAttachment

func WithAttachment(key string, value interface{}) SubscribeOption

WithAttachment provides an attachment (key-value pair).

func WithSubscriber

func WithSubscriber(subscriber subscribe.Subscriber) SubscribeOption

WithSubscriber provides a subscriber.

type SubscribeOptions

type SubscribeOptions struct {
	Subscribers []subscribe.Subscriber
	Attachments map[string]interface{}
}

SubscribeOptions represents the options of OpenSergo data subscription.