Documentation
¶
Index ¶
Constants ¶
View Source
const ( ContainerStatusPulling = "pulling" // Does not correspond to a Docker status. ContainerStatusCreated = "created" ContainerStatusRunning = "running" ContainerStatusPaused = "paused" ContainerStatusRestarting = "restarting" ContainerStatusRemoving = "removing" ContainerStatusExited = "exited" ContainerStatusDead = "dead" )
Container status strings.
TODO: refactor to strictly reflect Docker status strings.
View Source
const AppName = "octoplex"
AppName is the name of the app.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppState ¶
type AppState struct {
Source Source
Destinations []Destination
BuildInfo BuildInfo
}
AppState holds application state.
type Container ¶
type Container struct {
ID string
Status string
HealthState string
CPUPercent float64
MemoryUsageBytes uint64
RxRate int
TxRate int
RxSince time.Time
ImageName string
PullStatus string // PullStatus is the status of the image pull.
PullProgress string // PullProgress is the "progress string" of the image pull.
PullPercent int // PullPercent is the percentage of the image that has been pulled.
RestartCount int
ExitCode *int
Err error // Err is set if any error was received from the container client.
}
Container represents the current state of an individual container.
type Destination ¶
type Destination struct {
Container Container
Status DestinationStatus
ID uuid.UUID
Name string
URL string
}
Destination is a single destination.
type DestinationStatus ¶
type DestinationStatus int
DestinationStatus reflects the high-level status of a single destination.
const ( DestinationStatusOffAir DestinationStatus = iota DestinationStatusStarting DestinationStatusLive )
func (DestinationStatus) String ¶ added in v0.0.12
func (s DestinationStatus) String() string
String implements the fmt.Stringer interface for DestinationStatus.
type KeyPair ¶ added in v0.0.8
type KeyPair struct {
Cert, Key []byte
}
KeyPair holds a TLS key pair.
type KeyPairs ¶ added in v0.0.10
type KeyPairs struct {
Internal KeyPair // valid for localhost and any user-provided host
Custom KeyPair // valid only for any user-provided host, may be zero value
}
KeyPairs holds TLS key pairs for the server.
Click to show internal directories.
Click to hide internal directories.