config

package

v0.0.0-...-c4f21ae Latest Latest Go to latest Published: Aug 25, 2017 License: GPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func CreateLog(timestamp time.Time) (*os.File, error)

CreateLog checks for existence of a 'results' folder in current directory and creates and opens a log file for the current run.

type Config struct {
	Server   Server
	Settings Settings
	Session  Session
}

Config holds all information parsed from supplied config file.

func LoadConfig(configFile string) (*Config, error)

LoadConfig decodes the config file and creates a Config object.

type Server struct {
	Addr string
	TLS  bool
}

Server holds all server information including hostname and port.

type Session struct {
	MinLength int
	MaxLength int
}

Session holds all information about the length of one session.

type Settings struct {
	Threads  int
	Sessions int
	Seed     int64
	Throttle int
}

Settings holds all global parameters such as the number of threads and the seed to generate the involved IMAP commands.

type User struct {
	Username string
	Password string
}

User represents a user by name and password.

func LoadUsers(userdbFile string) ([]User, error)

LoadUsers populates all users from supplied file into a slice of above User struct.