options

Documentation

Overview

Package options contains flags and options for initializing a sms server

Index

• Constants
• type Options
  • func NewOptions() *Options
  • func (o *Options) ApplyTo(c *sms.Config) error
  • func (o *Options) Complete() error
  • func (o *Options) Config() (*sms.Config, error)
  • func (o *Options) Flags() (fss cliflag.NamedFlagSets)
  • func (o *Options) Validate() error

Constants

const (
	// UserAgent is the userAgent name when starting monster-sms server.
	UserAgent = "monster-sms"
)

Types

type Options

type Options struct {
	GRPCOptions  *genericoptions.GRPCOptions  `json:"grpc" mapstructure:"grpc"`
	HTTPOptions  *genericoptions.HTTPOptions  `json:"http" mapstructure:"http"`
	TLSOptions   *genericoptions.TLSOptions   `json:"tls" mapstructure:"tls"`
	MySQLOptions *genericoptions.MySQLOptions `json:"mysql" mapstructure:"mysql"`
	//Redis options for configuring Redis related options.
	RedisOptions *genericoptions.RedisOptions `json:"redis" mapstructure:"redis"`
	// Kafka options for configuring Kafka related options.
	CommonKafkaOptions  *genericoptions.KafkaOptions `json:"commonKafka" mapstructure:"commonKafka"`
	VerifyKafkaOptions  *genericoptions.KafkaOptions `json:"verifyKafka" mapstructure:"verifyKafka"`
	UplinkKafkaOptions  *genericoptions.KafkaOptions `json:"uplinkKafka" mapstructure:"uplinkKafka"`
	MonitorKafkaOptions *genericoptions.KafkaOptions `json:"monitorKafka" mapstructure:"monitorKafka"`
	Log                 *log.Options                 `json:"log" mapstructure:"log"`
	AliyunSmsOptions    *ailiyun.SmsOptions          `json:"ailiyun" mapstructure:"ailiyun"`
}

Options contains state for master/api server.

func NewOptions

func NewOptions() *Options

NewOptions returns initialized Options.

func (*Options) ApplyTo

func (o *Options) ApplyTo(c *sms.Config) error

ApplyTo fills up monster-fakeserver config with options.

func (*Options) Complete

func (o *Options) Complete() error

Complete completes all the required options.

func (*Options) Config

func (o *Options) Config() (*sms.Config, error)

Config return an monster-fakeserver config object.

func (*Options) Flags

func (o *Options) Flags() (fss cliflag.NamedFlagSets)

Flags returns flags for a specific server by section name.

func (*Options) Validate

func (o *Options) Validate() error

Validate validates all the required options.