configstatus

Documentation

Index

• Constants
• type ConfigAbortBuilder
  • func (*ConfigAbortBuilder) New(config *ConfigurationStatus) ConfigAbortData
• type ConfigAbortData
• type ConfigAbortDimensions
• type ConfigAbortValues
• type ConfigProgressBuilder
  • func (*ConfigProgressBuilder) New(config *ConfigurationStatus) ConfigProgressData
• type ConfigProgressData
• type ConfigProgressValues
• type ConfigRecoveryBuilder
  • func (*ConfigRecoveryBuilder) New(config *ConfigurationStatus) ConfigRecoveryData
• type ConfigRecoveryData
• type ConfigRecoveryDimensions
• type ConfigRecoveryValues
• type ConfigSuccessBuilder
  • func (*ConfigSuccessBuilder) New(config *ConfigurationStatus) ConfigSuccessData
• type ConfigSuccessData
• type ConfigSuccessDimensions
• type ConfigSuccessValues
• type ConfigurationStatus
  • func LoadConfigurationStatus(filepath string) (*ConfigurationStatus, error)
  • func (status *ConfigurationStatus) ApplyFailure(err string) error
  • func (status *ConfigurationStatus) ApplyProgress() error
  • func (status *ConfigurationStatus) ApplySuccess() error
  • func (status *ConfigurationStatus) AutoconfigUsed(client string) error
  • func (status *ConfigurationStatus) IsFromFailure() bool
  • func (status *ConfigurationStatus) IsPending() bool
  • func (status *ConfigurationStatus) Load() error
  • func (status *ConfigurationStatus) RecordLinkClicked(link uint) error
  • func (status *ConfigurationStatus) Remove() error
  • func (status *ConfigurationStatus) ReportClicked() error
  • func (status *ConfigurationStatus) ReportSent() error
  • func (status *ConfigurationStatus) Save() error
• type ConfigurationStatusData
• type DataV1
• type Metadata
• type MetadataOnly

Constants

const ProgressCheckInterval = time.Hour

Types

type ConfigAbortBuilder

type ConfigAbortBuilder struct{}

func (*ConfigAbortBuilder) New

func (*ConfigAbortBuilder) New(config *ConfigurationStatus) ConfigAbortData

type ConfigAbortData

type ConfigAbortData struct {
	MeasurementGroup string
	Event            string
	Values           ConfigSuccessValues
	Dimensions       ConfigSuccessDimensions
}

type ConfigAbortDimensions

type ConfigAbortDimensions struct {
	ReportClick string `json:"report_click"`
	ReportSent  string `json:"report_sent"`
	ClickedLink string `json:"clicked_link"`
}

type ConfigAbortValues

type ConfigAbortValues struct {
	Duration int `json:"duration"`
}

type ConfigProgressBuilder

type ConfigProgressBuilder struct{}

func (*ConfigProgressBuilder) New

func (*ConfigProgressBuilder) New(config *ConfigurationStatus) ConfigProgressData

type ConfigProgressData

type ConfigProgressData struct {
	MeasurementGroup string
	Event            string
	Values           ConfigProgressValues
	Dimensions       struct{}
}

type ConfigProgressValues

type ConfigProgressValues struct {
	NbDay          int `json:"nb_day"`
	NbDaySinceLast int `json:"nb_day_since_last"`
}

type ConfigRecoveryBuilder

type ConfigRecoveryBuilder struct{}

func (*ConfigRecoveryBuilder) New

func (*ConfigRecoveryBuilder) New(config *ConfigurationStatus) ConfigRecoveryData

type ConfigRecoveryData

type ConfigRecoveryData struct {
	MeasurementGroup string
	Event            string
	Values           ConfigRecoveryValues
	Dimensions       ConfigRecoveryDimensions
}

type ConfigRecoveryDimensions

type ConfigRecoveryDimensions struct {
	Autoconf       string `json:"autoconf"`
	ReportClick    string `json:"report_click"`
	ReportSent     string `json:"report_sent"`
	ClickedLink    string `json:"clicked_link"`
	FailureDetails string `json:"failure_details"`
}

type ConfigRecoveryValues

type ConfigRecoveryValues struct {
	Duration int `json:"duration"`
}

type ConfigSuccessBuilder

type ConfigSuccessBuilder struct{}

func (*ConfigSuccessBuilder) New

func (*ConfigSuccessBuilder) New(config *ConfigurationStatus) ConfigSuccessData

type ConfigSuccessData

type ConfigSuccessData struct {
	MeasurementGroup string
	Event            string
	Values           ConfigSuccessValues
	Dimensions       ConfigSuccessDimensions
}

type ConfigSuccessDimensions

type ConfigSuccessDimensions struct {
	Autoconf    string `json:"autoconf"`
	ReportClick string `json:"report_click"`
	ReportSent  string `json:"report_sent"`
	ClickedLink string `json:"clicked_link"`
}

type ConfigSuccessValues

type ConfigSuccessValues struct {
	Duration int `json:"duration"`
}

type ConfigurationStatus

type ConfigurationStatus struct {
	FilePath string
	DataLock safe.RWMutex

	Data *ConfigurationStatusData
}

func LoadConfigurationStatus

func LoadConfigurationStatus(filepath string) (*ConfigurationStatus, error)

func (*ConfigurationStatus) ApplyFailure

func (status *ConfigurationStatus) ApplyFailure(err string) error

func (*ConfigurationStatus) ApplyProgress

func (status *ConfigurationStatus) ApplyProgress() error

func (*ConfigurationStatus) ApplySuccess

func (status *ConfigurationStatus) ApplySuccess() error

func (*ConfigurationStatus) AutoconfigUsed

func (status *ConfigurationStatus) AutoconfigUsed(client string) error

func (*ConfigurationStatus) IsFromFailure

func (status *ConfigurationStatus) IsFromFailure() bool

func (*ConfigurationStatus) IsPending

func (status *ConfigurationStatus) IsPending() bool

func (*ConfigurationStatus) Load

func (status *ConfigurationStatus) Load() error

func (*ConfigurationStatus) RecordLinkClicked

func (status *ConfigurationStatus) RecordLinkClicked(link uint) error

func (*ConfigurationStatus) Remove

func (status *ConfigurationStatus) Remove() error

func (*ConfigurationStatus) ReportClicked

func (status *ConfigurationStatus) ReportClicked() error

func (*ConfigurationStatus) ReportSent

func (status *ConfigurationStatus) ReportSent() error

func (*ConfigurationStatus) Save

func (status *ConfigurationStatus) Save() error

type ConfigurationStatusData

type ConfigurationStatusData struct {
	Metadata Metadata `json:"metadata"`
	DataV1   DataV1   `json:"dataV1"`
}

type DataV1

type DataV1 struct {
	PendingSince   time.Time `json:"pending_since"`
	LastProgress   time.Time `json:"last_progress"`
	Autoconf       string    `json:"auto_conf"`
	ClickedLink    uint64    `json:"clicked_link"`
	ReportSent     bool      `json:"report_sent"`
	ReportClick    bool      `json:"report_click"`
	FailureDetails string    `json:"failure_details"`
}

type Metadata

type Metadata struct {
	Version string `json:"version"`
}

type MetadataOnly

type MetadataOnly struct {
	Metadata Metadata `json:"metadata"`
}