cnf

Documentation

Index

• Constants
• func GetCacheDir() string
• func GetDownloadThreadNum() int
• func GetFetcher(dUrl string) (fetcher *request.Fetcher)
• func GetReverseProxyUri(dUrl, localProxy string) string
• func GetSDKInstallationConfDir() string
• func GetSDKInstallationConfFileUrlBySDKName(sdkName string) string
• func GetSDKListFileUrl() string
• func GetTempDir() string
• func GetVMRConfFilePath() string
• func GetVMRWorkDir() string
• func GetVersionFileUrlBySDKName(sdkName string) string
• func GetVersionsDir() string
• func LoadCustomedMirror() map[string]string
• func UseCustomedMirrorUrl(dUrl string) string
• type VMRConf
  • func NewVMRConf() (v *VMRConf)
  • func (v *VMRConf) Load()
  • func (v *VMRConf) Save()
  • func (v *VMRConf) SetDownloadThreadNum(num int)
  • func (v *VMRConf) SetProxyUri(sUri string)
  • func (v *VMRConf) SetReverseProxy(sUri string)
  • func (v *VMRConf) SetVersionHostUrl(hUrl string)
  • func (v *VMRConf) ToggleUseCustomedMirrors()

Constants

const (
	DefaultReverseProxy       string = "https://proxy.vmr.us.kg/proxy/"
	DefaultHostUrl            string = "https://raw.githubusercontent.com/gvcgo/vsources/main"
	SDKNameListFileUrl        string = `/sdk-list.version.json`
	VersionFileUrlPattern     string = `/%s.version.json`
	SDKInstallationUrlPattern string = `install/%s.toml`
	VMRWorkDirName            string = ".vmr"
)

const (
	VMRSdkInstallationDirEnv string = "VMR_SDK_INSTALLATION_DIR"
	VMRHostUrlEnv            string = "VMR_HOST"
	VMRReverseProxyEnv       string = "VMR_REVERSE_PROXY"
	VMRLocalProxyEnv         string = "VMR_LOCAL_PROXY"
	VMRDonwloadThreadEnv     string = "VMR_DOWNLOAD_THREADS"
	VMRUseCustomedMirrorEnv  string = "VMR_USE_CUSTOMED_MIRRORS"
)

Envs

Functions

func GetCacheDir

func GetCacheDir() string

cache file dir:

where the downloaded files are stored.

func GetDownloadThreadNum

func GetDownloadThreadNum() int

Get download thread num

func GetFetcher

func GetFetcher(dUrl string) (fetcher *request.Fetcher)

Prepares request.Fetcher for URL.

func GetReverseProxyUri

func GetReverseProxyUri(dUrl, localProxy string) string

reverse proxy

func GetSDKInstallationConfDir

func GetSDKInstallationConfDir() string

This directory is for storing sdk installation config files.

func GetSDKInstallationConfFileUrlBySDKName

func GetSDKInstallationConfFileUrlBySDKName(sdkName string) string

install/{sdkname}.toml file

func GetSDKListFileUrl

func GetSDKListFileUrl() string

sdk-list.version.json

func GetTempDir

func GetTempDir() string

Temp directory is for unarchiving sdk files. And will be removed after the temp files are copied to installation directory.

func GetVMRConfFilePath

func GetVMRConfFilePath() string

vmr conf file path.

func GetVMRWorkDir

func GetVMRWorkDir() string

vmr work dir:

where vmr is installed.

func GetVersionFileUrlBySDKName

func GetVersionFileUrlBySDKName(sdkName string) string

{sdkname}.version.json file

func GetVersionsDir

func GetVersionsDir() string

versions dir:

where the versions are installed.

func LoadCustomedMirror

func LoadCustomedMirror() map[string]string

func UseCustomedMirrorUrl

func UseCustomedMirrorUrl(dUrl string) string

Types

type VMRConf

type VMRConf struct {
	ProxyUri           string `json,toml:"proxy_uri"`
	ReverseProxy       string `json,toml:"reverse_proxy"`
	SDKIntallationDir  string `json,toml:"sdk_installation_dir"`
	VersionHostUrl     string `json,toml:"version_host_url"`
	ThreadNum          int    `json,toml:"download_thread_num"`
	UseCustomedMirrors bool   `json,toml:"use_customed_mirrors"`
}

============================== vmr config file. ==============================

var DefaultConfig *VMRConf

func NewVMRConf

func NewVMRConf() (v *VMRConf)

func (*VMRConf) Load

func (v *VMRConf) Load()

func (*VMRConf) Save

func (v *VMRConf) Save()

func (*VMRConf) SetDownloadThreadNum

func (v *VMRConf) SetDownloadThreadNum(num int)

func (*VMRConf) SetProxyUri

func (v *VMRConf) SetProxyUri(sUri string)

func (*VMRConf) SetReverseProxy

func (v *VMRConf) SetReverseProxy(sUri string)

func (*VMRConf) SetVersionHostUrl

func (v *VMRConf) SetVersionHostUrl(hUrl string)

func (*VMRConf) ToggleUseCustomedMirrors

func (v *VMRConf) ToggleUseCustomedMirrors()