interfaces

package module

v0.4.5-alpha2 Latest Latest Go to latest Published: Jun 19, 2023 License: Apache-2.0 Imports: 0 Imported by: 6

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

Repository

github.com/IceWhaleTech/CasaOS-Common

README ¶

CasaOS-Common

Common structs and functions for CasaOS

Documentation ¶

Index ¶

type MigrationTool

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type MigrationTool ¶

type MigrationTool interface {
	IsMigrationNeeded() (bool, error)
	PreMigrate() error
	Migrate() error
	PostMigrate() error
}

Any logic to migrate data from previous version to current can implement this interface.

The model for migrating from v0.n to v0.m is an execution chain of each version of this migration tool:

START -> migration-tool-v0.n -> migration-tool-v0.n+1 -> ... -> migration-tool-v0.m -> END

Therefore, each migration tool in the chain SHOULD ONLY work on data such as config files and databases. It is responsibility of any install/setup script to control the services because it knows when migration starts and ends.

!!!IMPORTANT!!! DO NOT stop, start, enable or disable services, because the whole execution chain might not have been completed.

Source Files ¶

View all Source files

interfaces.go

Directories ¶

Path	Synopsis
external The commmon package provides structs and functions for external code to interact with this gateway service.	The commmon package provides structs and functions for external code to interact with this gateway service.
middleware @Author: LinkLeong link@icewhale.com	@Author: LinkLeong link@icewhale.com
model
notify @Author: LinkLeong link@icewhale.com	@Author: LinkLeong link@icewhale.com
utils
common_err
constants
file
http methods in this package automatically include a context with a timeout, in order to solve the problem of hanging requests and to avoid goroutine leaks	methods in this package automatically include a context with a timeout, in order to solve the problem of hanging requests and to avoid goroutine leaks
jwt
logger
port
random
ssh
systemctl
time
version

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL