Documentation
¶
Index ¶
- Constants
- func GetCWD() string
- func GetDefaultBputForSync() bool
- func GetDefaultFilesystemTimeoutInSeconds() int
- func GetDefaultIRODSConfigPath() string
- func GetDefaultTCPRecvBufferSize() int
- func GetDefaultTCPRecvBufferSizeString() string
- func GetDefaultTCPSendBufferSize() int
- func GetDefaultTCPSendBufferSizeString() string
- func GetDefaultTransferThreadNum() int
- func GetDefaultTransferThreadNumPerFile() int
- func GetDefaultVerifyChecksum() bool
- func GetEnvName(p string) string
- func GetEnvironmentManager() *irodsclient_config.ICommandsEnvironmentManager
- func GetHomeDir() string
- func GetSessionConfig() *irodsclient_config.Config
- func GetSystemConfigPath() (string, error)
- func InitEnvironmentManager() error
- func InitEnvironmentManagerFromSystemConfig() error
- func InitSystemConfig() error
- func InputFieldsForInit() (bool, error)
- func InputMissingFields() (bool, error)
- func InputMissingFieldsFromStdin() error
- func IsTargetEnvFile(p string) bool
- func MakeEnvFileName(envName string) string
- func SetCWD(cwd string) error
- type AdditionalSystemConfig
- type ConfigTypeIn
- type SystemConfig
Constants ¶
View Source
const ( GoCommandsRepoPackagePath string = "cyverse/gocommands" ClientProgramName string = "gocommands" FilesystemTimeout irodsclient_types.Duration = irodsclient_types.Duration(5 * time.Minute) LongFilesystemTimeout irodsclient_types.Duration = irodsclient_types.Duration(10 * time.Minute) // exceptionally long timeout for listing dirs or users MinFileNumInBundleDefault int = 3 MaxFileNumInBundleDefault int = 50 MaxFileSizeInBundleDefault int64 = 32 * 1024 * 1024 // 32MB MaxBundleFileSizeDefault int64 = 2 * 1024 * 1024 * 1024 // 2GB )
Variables ¶
This section is empty.
Functions ¶
func GetDefaultBputForSync ¶
func GetDefaultBputForSync() bool
func GetDefaultFilesystemTimeoutInSeconds ¶ added in v0.12.3
func GetDefaultFilesystemTimeoutInSeconds() int
func GetDefaultIRODSConfigPath ¶
func GetDefaultIRODSConfigPath() string
GetDefaultIRODSConfigPath returns default config path
func GetDefaultTCPRecvBufferSize ¶ added in v0.12.5
func GetDefaultTCPRecvBufferSize() int
func GetDefaultTCPRecvBufferSizeString ¶ added in v0.12.5
func GetDefaultTCPRecvBufferSizeString() string
func GetDefaultTCPSendBufferSize ¶ added in v0.12.5
func GetDefaultTCPSendBufferSize() int
func GetDefaultTCPSendBufferSizeString ¶ added in v0.12.5
func GetDefaultTCPSendBufferSizeString() string
func GetDefaultTransferThreadNum ¶
func GetDefaultTransferThreadNum() int
func GetDefaultTransferThreadNumPerFile ¶
func GetDefaultTransferThreadNumPerFile() int
func GetDefaultVerifyChecksum ¶
func GetDefaultVerifyChecksum() bool
func GetEnvName ¶ added in v0.11.3
func GetEnvironmentManager ¶
func GetEnvironmentManager() *irodsclient_config.ICommandsEnvironmentManager
GetEnvironmentManager returns environment manager
func GetSessionConfig ¶
func GetSessionConfig() *irodsclient_config.Config
GetSessionConfig returns session configuration
func GetSystemConfigPath ¶
GetSystemConfigPath returns the system-specific configuration file path for gocmd
func InitEnvironmentManager ¶
func InitEnvironmentManager() error
InitEnvironmentManager initializes envionment manager
func InitEnvironmentManagerFromSystemConfig ¶
func InitEnvironmentManagerFromSystemConfig() error
InitEnvironmentManagerFromSystemConfig initializes envionment manager
func InitSystemConfig ¶
func InitSystemConfig() error
func InputMissingFields ¶
InputMissingFields inputs missing fields
func InputMissingFieldsFromStdin ¶
func InputMissingFieldsFromStdin() error
InputMissingFieldsFromStdin inputs missing fields
func IsTargetEnvFile ¶ added in v0.11.3
func MakeEnvFileName ¶ added in v0.11.3
Types ¶
type AdditionalSystemConfig ¶
type AdditionalSystemConfig struct {
TransferMode string `json:"transfer_mode,omitempty" yaml:"transfer_mode,omitempty"`
BputForSync bool `json:"bput_for_sync,omitempty" yaml:"bput_for_sync,omitempty"`
TCPSendBufferSize string `json:"tcp_send_buffer_size,omitempty" yaml:"tcp_send_buffer_size,omitempty"`
TCPRecvBufferSize string `json:"tcp_recv_buffer_size,omitempty" yaml:"tcp_recv_buffer_size,omitempty"`
TransferThreadNum int `json:"transfer_thread_num,omitempty" yaml:"transfer_thread_num,omitempty"`
TransferThreadNumPerFile int `json:"transfer_thread_num_per_file,omitempty" yaml:"transfer_thread_num_per_file,omitempty"`
VerifyChecksum bool `json:"verify_checksum,omitempty" yaml:"verify_checksum,omitempty"`
}
type ConfigTypeIn ¶
type ConfigTypeIn struct {
Host string `yaml:"irods_host,omitempty"`
Port int `yaml:"irods_port,omitempty"`
ZoneName string `yaml:"irods_zone_name,omitempty"`
Username string `yaml:"irods_user_name,omitempty"`
Password string `yaml:"irods_user_password,omitempty"`
}
ConfigTypeIn stores data that user can input if missing
func NewConfigTypeInFromYAML ¶
func NewConfigTypeInFromYAML(yamlBytes []byte) (*ConfigTypeIn, error)
NewConfigTypeInFromYAML creates ConfigTypeIn from YAML
func (*ConfigTypeIn) ToYAML ¶
func (config *ConfigTypeIn) ToYAML() ([]byte, error)
ToYAML converts to YAML bytes
type SystemConfig ¶
type SystemConfig struct {
IRODSConfig map[string]interface{} `json:"irods_config,omitempty" yaml:"irods_config,omitempty"`
AdditionalConfig *AdditionalSystemConfig `json:"additional_config,omitempty" yaml:"additional_config,omitempty"`
}
SystemConfig stores system-specific configuration
func GetSystemConfig ¶
func GetSystemConfig() *SystemConfig
func NewSystemConfig ¶
func NewSystemConfig() (*SystemConfig, error)
NewSystemConfig reads SystemConfig from a JSON file located at default path
func (*SystemConfig) GetIRODSConfig ¶
func (sysConfig *SystemConfig) GetIRODSConfig() (*irodsclient_config.Config, error)
Source Files
Click to show internal directories.
Click to hide internal directories.