commons

Documentation

Index

• Constants
• func GetDefaultDataCacheRootPath() string
• func GetDefaultLogFilePath() string
• func GetServiceVersion() string
• func GetVersionJSON() (string, error)
• type Config
  • func NewConfigFromYAML(yamlBytes []byte) (*Config, error)
  • func NewDefaultConfig() *Config
  • func (config *Config) Validate() error
• type Duration
  • func (d *Duration) MarshalJSON() ([]byte, error)
  • func (d *Duration) UnmarshalJSON(b []byte) error
  • func (d *Duration) UnmarshalYAML(unmarshal func(interface{}) error) error
• type MetadataCacheTimeoutSetting
• type VersionInfo
  • func GetVersion() VersionInfo

Constants

const (
	ServicePortDefault             int    = 12020
	BufferSizeMaxDefault           int64  = 1024 * 1024 * 64        // 64MB
	DataCacheSizeMaxDefault        int64  = 1024 * 1024 * 1024 * 20 // 20GB
	DataCacheRootPathPrefixDefault string = "/tmp/irodsfs_pool"
	LogFilePathPrefixDefault       string = "/tmp/irodsfs_pool"
	ProfileServicePortDefault      int    = 12021
)

Functions

func GetDefaultDataCacheRootPath

func GetDefaultDataCacheRootPath() string

GetDefaultDataCacheRootPath returns default data cache root path

func GetDefaultLogFilePath

func GetDefaultLogFilePath() string

GetDefaultLogFilePath returns default log file path

func GetServiceVersion

func GetServiceVersion() string

GetServiceVersion returns service version in string

func GetVersionJSON

func GetVersionJSON() (string, error)

GetVersionJSON returns VersionInfo object in JSON string

Types

type Config

type Config struct {
	ServicePort          int                           `yaml:"service_port"`
	BufferSizeMax        int64                         `yaml:"buffer_size_max"`
	DataCacheSizeMax     int64                         `yaml:"data_cache_size_max"`
	DataCacheRootPath    string                        `yaml:"data_cache_root_path"`
	CacheTimeoutSettings []MetadataCacheTimeoutSetting `yaml:"cache_timeout_settings,omitempty"`

	LogPath string `yaml:"log_path,omitempty"`

	Profile            bool `yaml:"profile,omitempty"`
	ProfileServicePort int  `yaml:"profile_service_port,omitempty"`

	Foreground   bool `yaml:"foreground,omitempty"`
	ChildProcess bool `yaml:"childprocess,omitempty"`

	InstanceID string `yaml:"instanceid,omitempty"`
}

Config holds the parameters list which can be configured

func NewConfigFromYAML

func NewConfigFromYAML(yamlBytes []byte) (*Config, error)

NewConfigFromYAML creates Config from YAML

func NewDefaultConfig

func NewDefaultConfig() *Config

NewDefaultConfig creates DefaultConfig

func (*Config) Validate

func (config *Config) Validate() error

Validate validates configuration

type Duration

type Duration time.Duration

Duration is a replacement of time.Duration that supports JSON

func (*Duration) MarshalJSON

func (d *Duration) MarshalJSON() ([]byte, error)

MarshalJSON ...

func (*Duration) UnmarshalJSON

func (d *Duration) UnmarshalJSON(b []byte) error

UnmarshalJSON ...

func (*Duration) UnmarshalYAML

func (d *Duration) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML ...

type MetadataCacheTimeoutSetting

type MetadataCacheTimeoutSetting struct {
	Path    string   `yaml:"path" json:"path"`
	Timeout Duration `yaml:"timeout" json:"timeout"`
	Inherit bool     `yaml:"inherit,omitempty" json:"inherit,omitempty"`
}

MetadataCacheTimeoutSetting defines cache timeout for path

type VersionInfo

type VersionInfo struct {
	ServiceVersion string `json:"serviceVersion"`
	GitCommit      string `json:"gitCommit"`
	BuildDate      string `json:"buildDate"`
	GoVersion      string `json:"goVersion"`
	Compiler       string `json:"compiler"`
	Platform       string `json:"platform"`
}

VersionInfo object contains version related info

func GetVersion

func GetVersion() VersionInfo

GetVersion returns VersionInfo object