settings

Documentation

Overview

Package settings - holds configuration specific to a Retrieval Gateway node.

Index

• Constants
• type AppSettings

Constants

const DefaultLongTCPInactivityTimeout = 5000 * time.Millisecond

DefaultLongTCPInactivityTimeout is the default timeout for long TCP inactivity. This timeout should never be ignored.

const DefaultRegisterRefreshDuration = 5000 * time.Millisecond

DefaultRegisterRefreshDuration is the default register refresh duration

const DefaultTCPInactivityTimeout = 100 * time.Millisecond

DefaultTCPInactivityTimeout is the default timeout for TCP inactivity

Types

type AppSettings

type AppSettings struct {
	BindRestAPI     string `mapstructure:"BIND_REST_API"`     // Port number to bind to for client REST API.
	BindProviderAPI string `mapstructure:"BIND_PROVIDER_API"` // Port number to bind to for provider TCP communication API.
	BindGatewayAPI  string `mapstructure:"BIND_GATEWAY_API"`  // Port number to bind to for gateway TCP communication API.
	BindAdminAPI    string `mapstructure:"BIND_ADMIN_API"`    // Port number to bind to for admin TCP communication API.
	LogLevel        string `mapstructure:"LOG_LEVEL"`         // Log Level: NONE, ERROR, WARN, INFO, TRACE
	LogTarget       string `mapstructure:"LOG_TARGET"`        // Log Level: STDOUT
	LogDir          string `mapstructure:"LOG_DIR"`           // Log Dir: /var/log/fc-retrieval/fc-retrieval-gateway
	LogFile         string `mapstructure:"LOG_FILE"`          // Log File: gateway.log
	LogMaxBackups   int    `mapstructure:"LOG_MAX_BACKUPS"`   // Log max backups: 3
	LogMaxAge       int    `mapstructure:"LOG_MAX_AGE"`       // Log max age (days): 28
	LogMaxSize      int    `mapstructure:"LOG_MAX_SIZE"`      // Log max size (MB): 500
	LogCompress     bool   `mapstructure:"LOG_COMPRESS"`      // Log compress: false
	GatewayID       string `mapstructure:"GATEWAY_ID"`        // Node id of this gateway

	RegisterAPIURL          string        `mapstructure:"REGISTER_API_URL"`          // Register service url
	RegisterRefreshDuration time.Duration `mapstructure:"REGISTER_REFRESH_DURATION"` // Register refresh duration
	GatewayAddress          string        `mapstructure:"GATEWAY_ADDRESS"`           // Gateway address
	NetworkInfoGateway      string        `mapstructure:"GATEWAY_NETWORK_INFO"`      // Gateway network info
	GatewayRegionCode       string        `mapstructure:"GATEWAY_REGION_CODE"`       // Gateway region code
	GatewayRootSigningKey   string        `mapstructure:"GATEWAY_ROOT_SIGNING_KEY"`  // Gateway root signing key
	GatewaySigningKey       string        `mapstructure:"GATEWAY_SIGNING_KEY"`       // Gateway signing key

	NetworkInfoClient   string `mapstructure:"CLIENT_NETWORK_INFO"`   // Gateway client network info
	NetworkInfoProvider string `mapstructure:"PROVIDER_NETWORK_INFO"` // Gateway provider network info
	NetworkInfoAdmin    string `mapstructure:"ADMIN_NETWORK_INFO"`    // Gateway admin network info

	TCPInactivityTimeout     time.Duration `mapstructure:"TCP_INACTIVITY_TIMEOUT"`      // TCP inactivity timeout
	TCPLongInactivityTimeout time.Duration `mapstructure:"TCP_LONG_INACTIVITY_TIMEOUT"` // TCP long inactivity timeout

	SearchPrice *big.Int `mapstructure:"SEARCH_PRICE"`
	OfferPrice  *big.Int `mapstructure:"OFFER_PRICE"`
	TopupAmount *big.Int `mapstructure:"TOPUP_AMOUNT"`
}

AppSettings defines the server configuraiton