temporal

type Delays struct {
	Small  time.Duration `json:"delay_small,omitempty" mapstructure:"small"`
	Normal time.Duration `json:"delay_normal,omitempty" mapstructure:"normal"`
	Big    time.Duration `json:"delay_big,omitempty" mapstructure:"big"`
}

type MutableTimings struct {
	Timeouts `json:"timeouts" mapstructure:"timeouts"`
	Delays   `json:"delays" mapstructure:"delays"`
}

type Stopwatch interface {
	// Start starts the stopwatch, either for the first time or after a Pause()
	Start()
	// Stop stops definitively the stopwatch, disabling the ability to start it again
	Stop()
	// Pause stops temporarily the stopwatch, allowing to start it again, suming up the time intervals
	Pause()
	// GetDuration returns the current elapsed time measured by the Stopwatch
	GetDuration() time.Duration
	// String returns a printable representation of the current elapsed time
	String() string
	// OnExitLogWithLevel returns a function that will log start and end of Stopwatch, intended tto be used with defer
	OnExitLogWithLevel(ctx context.Context, in, out string, level logrus.Level) func()

	OnExitLogInfo(ctx context.Context, in, out string) func()
}

type Timeouts struct {
	Communication          time.Duration `json:"timeout_communication,omitempty" mapstructure:"communication"`
	Connection             time.Duration `json:"timeout_connection,omitempty" mapstructure:"connection"`
	Context                time.Duration `json:"timeout_context,omitempty" mapstructure:"context"`
	HostCreation           time.Duration `json:"timeout_host_creation,omitempty" mapstructure:"hostcreation"`
	HostBoot               time.Duration `json:"timeout_host_boot,omitempty" mapstructure:"hostboot"`
	HostCleanup            time.Duration `json:"timeout_host_cleanup,omitempty" mapstructure:"hostcleanup"`
	HostOperation          time.Duration `json:"timeout_host_operation,omitempty" mapstructure:"hostoperation"`
	HostLongOperation      time.Duration `json:"timeout_host_long_operation,omitempty" mapstructure:"hostlongoperation"`
	Operation              time.Duration `json:"timeout_operation,omitempty" mapstructure:"operation"`
	SSHConnection          time.Duration `json:"timeout_ssh_connection,omitempty" mapstructure:"sshconnection"`
	Metadata               time.Duration `json:"timeout_metadata,omitempty" mapstructure:"metadata"`
	MetadataReadAfterWrite time.Duration `json:"timeout_metadata_raw,omitempty" mapstructure:"metadatareadafterwrite"`
	RebootTimeout          time.Duration `json:"timeout_reboot,omitempty" mapstructure:"reboot"`
}

type Timings interface {
	// OperationTimeout ...
	OperationTimeout() time.Duration

	// HostOperationTimeout ...
	HostOperationTimeout() time.Duration

	// HostLongOperationTimeout ...
	HostLongOperationTimeout() time.Duration

	// HostCreationTimeout ...
	HostCreationTimeout() time.Duration

	// HostBootTimeout ...
	HostBootTimeout() time.Duration

	// HostCleanupTimeout ...
	HostCleanupTimeout() time.Duration

	// CommunicationTimeout ...
	CommunicationTimeout() time.Duration

	// ConnectionTimeout ...
	ConnectionTimeout() time.Duration

	// ContextTimeout ...
	ContextTimeout() time.Duration

	// ExecutionTimeout ...
	ExecutionTimeout() time.Duration

	// SSHConnectionTimeout ...
	SSHConnectionTimeout() time.Duration

	// MetadataTimeout ...
	MetadataTimeout() time.Duration

	// RebootTimeout ...
	RebootTimeout() time.Duration

	// MetadataReadAfterWriteTimeout ...
	MetadataReadAfterWriteTimeout() time.Duration

	// SmallDelay ...
	SmallDelay() time.Duration
	// NormalDelay returns the currently configure normal delay stored in Timings
	NormalDelay() time.Duration
	// BigDelay returns the currently configured big delay stored in Timings
	BigDelay() time.Duration
}