options

Documentation

Overview

Package options contains flags and options for initializing an apiserver

Index

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

Constants

const (
	// UserAgent is the userAgent name when starting onex-gateway server.
	UserAgent = "onex-toyblc"
)

Types

type Options

type Options struct {
	Miner            bool                        `json:"miner" mapstructure:"miner"`
	MinMineInterval  time.Duration               `json:"min-mine-interval" mapstructure:"min-mine-interval"`
	MiningDifficulty int                         `json:"mining-difficulty" mapstructure:"mining-difficulty"`
	Address          string                      `json:"address" mapstructure:"address"`
	Accounts         map[string]string           `json:"accounts" mapstructure:"-"`
	P2PAddr          string                      `json:"p2p-addr" mapstructure:"p2p-addr"`
	Peers            []string                    `json:"peers" mapstructure:"peers"`
	HTTPOptions      *genericoptions.HTTPOptions `json:"http" mapstructure:"http"`
	TLSOptions       *genericoptions.TLSOptions  `json:"tls" mapstructure:"tls"`
	Log              *log.Options                `json:"log" mapstructure:"log"`
}

Options contains state for master/api server.

func NewOptions

func NewOptions() *Options

NewOptions returns initialized Options.

func (*Options) ApplyTo

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

ApplyTo fills up onex-toyblc config with options.

func (*Options) Complete

func (o *Options) Complete() error

Complete completes all the required options.

func (*Options) Config

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

Config return an onex-toyblc 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.