config

Documentation

Overview

Package config //

Package config //

Index

• Constants
• type OptionFunc
  • func WithDatafileURLTemplate(datafileTemplate string) OptionFunc
  • func WithInitialDatafile(datafile []byte) OptionFunc
  • func WithPollingInterval(interval time.Duration) OptionFunc
  • func WithRequester(requester utils.Requester) OptionFunc
• type PollingProjectConfigManager
  • func NewPollingProjectConfigManager(sdkKey string, pollingMangerOptions ...OptionFunc) *PollingProjectConfigManager
  • func (cm *PollingProjectConfigManager) GetConfig() (pkg.ProjectConfig, error)
  • func (cm *PollingProjectConfigManager) OnProjectConfigUpdate(callback func(notification.ProjectConfigUpdateNotification)) (int, error)
  • func (cm *PollingProjectConfigManager) RemoveOnProjectConfigUpdate(id int) error
  • func (cm *PollingProjectConfigManager) Start(sdkKey string, exeCtx utils.ExecutionCtx)
  • func (cm *PollingProjectConfigManager) SyncConfig(sdkKey string, datafile []byte)
• type StaticProjectConfigManager
  • func NewStaticProjectConfigManager(config pkg.ProjectConfig) *StaticProjectConfigManager
  • func NewStaticProjectConfigManagerFromPayload(payload []byte) (*StaticProjectConfigManager, error)
  • func NewStaticProjectConfigManagerFromURL(sdkKey string) (*StaticProjectConfigManager, error)
  • func (cm *StaticProjectConfigManager) GetConfig() (pkg.ProjectConfig, error)
  • func (cm *StaticProjectConfigManager) OnProjectConfigUpdate(callback func(notification.ProjectConfigUpdateNotification)) (int, error)
  • func (cm *StaticProjectConfigManager) RemoveOnProjectConfigUpdate(id int) error

Constants

const DatafileURLTemplate = "https://cdn.optimizely.com/datafiles/%s.json"

DatafileURLTemplate is used to construct the endpoint for retrieving the datafile from the CDN

const DefaultPollingInterval = 5 * time.Minute // default to 5 minutes for polling

DefaultPollingInterval sets default interval for polling manager

const LastModified = "Last-Modified"

LastModified header key for response

const ModifiedSince = "If-Modified-Since"

ModifiedSince header key for request

Types

type OptionFunc

type OptionFunc func(*PollingProjectConfigManager)

OptionFunc is used to provide custom configuration to the PollingProjectConfigManager.

func WithDatafileURLTemplate

func WithDatafileURLTemplate(datafileTemplate string) OptionFunc

WithDatafileURLTemplate is an optional function, sets a passed datafile URL template

func WithInitialDatafile

func WithInitialDatafile(datafile []byte) OptionFunc

WithInitialDatafile is an optional function, sets a passed datafile

func WithPollingInterval

func WithPollingInterval(interval time.Duration) OptionFunc

WithPollingInterval is an optional function, sets a passed polling interval

func WithRequester

func WithRequester(requester utils.Requester) OptionFunc

WithRequester is an optional function, sets a passed requester

type PollingProjectConfigManager

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

PollingProjectConfigManager maintains a dynamic copy of the project config by continuously polling for the datafile from the Optimizely CDN at a given (configurable) interval.

func NewPollingProjectConfigManager

func NewPollingProjectConfigManager(sdkKey string, pollingMangerOptions ...OptionFunc) *PollingProjectConfigManager

NewPollingProjectConfigManager returns an instance of the polling config manager with the customized configuration

func (*PollingProjectConfigManager) GetConfig

func (cm *PollingProjectConfigManager) GetConfig() (pkg.ProjectConfig, error)

GetConfig returns the project config

func (*PollingProjectConfigManager) OnProjectConfigUpdate

func (cm *PollingProjectConfigManager) OnProjectConfigUpdate(callback func(notification.ProjectConfigUpdateNotification)) (int, error)

OnProjectConfigUpdate registers a handler for ProjectConfigUpdate notifications

func (*PollingProjectConfigManager) RemoveOnProjectConfigUpdate

func (cm *PollingProjectConfigManager) RemoveOnProjectConfigUpdate(id int) error

RemoveOnProjectConfigUpdate removes handler for ProjectConfigUpdate notification with given id

func (*PollingProjectConfigManager) Start

func (cm *PollingProjectConfigManager) Start(sdkKey string, exeCtx utils.ExecutionCtx)

Start starts the polling

func (*PollingProjectConfigManager) SyncConfig

func (cm *PollingProjectConfigManager) SyncConfig(sdkKey string, datafile []byte)

SyncConfig gets current datafile and updates projectConfig

type StaticProjectConfigManager

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

StaticProjectConfigManager maintains a static copy of the project config

func NewStaticProjectConfigManager

func NewStaticProjectConfigManager(config pkg.ProjectConfig) *StaticProjectConfigManager

NewStaticProjectConfigManager creates a new instance of the manager with the given project config

func NewStaticProjectConfigManagerFromPayload

func NewStaticProjectConfigManagerFromPayload(payload []byte) (*StaticProjectConfigManager, error)

NewStaticProjectConfigManagerFromPayload returns new instance of StaticProjectConfigManager for payload

func NewStaticProjectConfigManagerFromURL

func NewStaticProjectConfigManagerFromURL(sdkKey string) (*StaticProjectConfigManager, error)

NewStaticProjectConfigManagerFromURL returns new instance of StaticProjectConfigManager for URL

func (*StaticProjectConfigManager) GetConfig

func (cm *StaticProjectConfigManager) GetConfig() (pkg.ProjectConfig, error)

GetConfig returns the project config

func (*StaticProjectConfigManager) OnProjectConfigUpdate

func (cm *StaticProjectConfigManager) OnProjectConfigUpdate(callback func(notification.ProjectConfigUpdateNotification)) (int, error)

OnProjectConfigUpdate here satisfies interface

func (*StaticProjectConfigManager) RemoveOnProjectConfigUpdate

func (cm *StaticProjectConfigManager) RemoveOnProjectConfigUpdate(id int) error

RemoveOnProjectConfigUpdate here satisfies interface