dbus

package
v0.20.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 21, 2016 License: Apache-2.0, Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Integration with the systemd D-Bus API. See http://www.freedesktop.org/wiki/Software/systemd/dbus/

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PathBusEscape 

func PathBusEscape(path string) string

PathBusEscape sanitizes a constituent string of a dbus ObjectPath using the rules that systemd uses for serializing special characters.

Types

type Conn 

type Conn struct {
	// contains filtered or unexported fields
}

Conn is a connection to systemd's dbus endpoint.

func New 

func New() (*Conn, error)

New establishes a connection to the system bus and authenticates. Callers should call Close() when done with the connection.

func NewSystemdConnection added in v0.19.4 

func NewSystemdConnection() (*Conn, error)

NewSystemdConnection establishes a private, direct connection to systemd. This can be used for communicating with systemd without a dbus daemon. Callers should call Close() when done with the connection.

func NewUserConnection added in v0.19.4 

func NewUserConnection() (*Conn, error)

NewUserConnection establishes a connection to the session bus and authenticates. This can be used to connect to systemd user instances. Callers should call Close() when done with the connection.

func (*Conn) Close added in v0.19.4 

func (c *Conn) Close()

Close closes an established connection

func (*Conn) DisableUnitFiles 

func (c *Conn) DisableUnitFiles(files []string, runtime bool) ([]DisableUnitFileChange, error)

DisableUnitFiles() may be used to disable one or more units in the system (by removing symlinks to them from /etc or /run).

It takes a list of unit files to disable (either just file names or full absolute paths if the unit files are residing outside the usual unit search paths), and one boolean: whether the unit was enabled for runtime only (true, /run), or persistently (false, /etc).

This call returns an array with the changes made. The changes list consists of structures with three strings: the type of the change (one of symlink or unlink), the file name of the symlink and the destination of the symlink.

func (*Conn) EnableUnitFiles 

func (c *Conn) EnableUnitFiles(files []string, runtime bool, force bool) (bool, []EnableUnitFileChange, error)

EnableUnitFiles() may be used to enable one or more units in the system (by creating symlinks to them in /etc or /run).

It takes a list of unit files to enable (either just file names or full absolute paths if the unit files are residing outside the usual unit search paths), and two booleans: the first controls whether the unit shall be enabled for runtime only (true, /run), or persistently (false, /etc). The second one controls whether symlinks pointing to other units shall be replaced if necessary.

This call returns one boolean and an array with the changes made. The boolean signals whether the unit files contained any enablement information (i.e. an [Install]) section. The changes list consists of structures with three strings: the type of the change (one of symlink or unlink), the file name of the symlink and the destination of the symlink.

func (*Conn) GetUnitProperties 

func (c *Conn) GetUnitProperties(unit string) (map[string]interface{}, error)

GetUnitProperties takes the unit name and returns all of its dbus object properties.

func (*Conn) GetUnitProperty 

func (c *Conn) GetUnitProperty(unit string, propertyName string) (*Property, error)

func (*Conn) GetUnitTypeProperties 

func (c *Conn) GetUnitTypeProperties(unit string, unitType string) (map[string]interface{}, error)

GetUnitTypeProperties returns the extra properties for a unit, specific to the unit type. Valid values for unitType: Service, Socket, Target, Device, Mount, Automount, Snapshot, Timer, Swap, Path, Slice, Scope return "dbus.Error: Unknown interface" if the unitType is not the correct type of the unit

func (*Conn) GetUnitTypeProperty 

func (c *Conn) GetUnitTypeProperty(unit string, unitType string, propertyName string) (*Property, error)

func (*Conn) KillUnit 

func (c *Conn) KillUnit(name string, signal int32)

KillUnit takes the unit name and a UNIX signal number to send. All of the unit's processes are killed.

func (*Conn) LinkUnitFiles 

func (c *Conn) LinkUnitFiles(files []string, runtime bool, force bool) ([]LinkUnitFileChange, error)

LinkUnitFiles() links unit files (that are located outside of the usual unit search paths) into the unit search path.

It takes a list of absolute paths to unit files to link and two booleans. The first boolean controls whether the unit shall be enabled for runtime only (true, /run), or persistently (false, /etc). The second controls whether symlinks pointing to other units shall be replaced if necessary.

This call returns a list of the changes made. The list consists of structures with three strings: the type of the change (one of symlink or unlink), the file name of the symlink and the destination of the symlink.

func (*Conn) ListUnits 

func (c *Conn) ListUnits() ([]UnitStatus, error)

ListUnits returns an array with all currently loaded units. Note that units may be known by multiple names at the same time, and hence there might be more unit names loaded than actual units behind them.

func (*Conn) NewSubscriptionSet 

func (conn *Conn) NewSubscriptionSet() *SubscriptionSet

NewSubscriptionSet returns a new subscription set.

func (*Conn) Reload 

func (c *Conn) Reload() error

Reload instructs systemd to scan for and reload unit files. This is equivalent to a 'systemctl daemon-reload'.

func (*Conn) ReloadOrRestartUnit 

func (c *Conn) ReloadOrRestartUnit(name string, mode string, ch chan<- string) (int, error)

ReloadOrRestart attempts a reload if the unit supports it and use a restart otherwise.

func (*Conn) ReloadOrTryRestartUnit 

func (c *Conn) ReloadOrTryRestartUnit(name string, mode string, ch chan<- string) (int, error)

ReloadOrTryRestart attempts a reload if the unit supports it and use a "Try" flavored restart otherwise.

func (*Conn) ReloadUnit 

func (c *Conn) ReloadUnit(name string, mode string, ch chan<- string) (int, error)

ReloadUnit reloads a unit. Reloading is done only if the unit is already running and fails otherwise.

func (*Conn) ResetFailedUnit 

func (c *Conn) ResetFailedUnit(name string) error

ResetFailedUnit resets the "failed" state of a specific unit.

func (*Conn) RestartUnit 

func (c *Conn) RestartUnit(name string, mode string, ch chan<- string) (int, error)

RestartUnit restarts a service. If a service is restarted that isn't running it will be started.

func (*Conn) SetSubStateSubscriber 

func (c *Conn) SetSubStateSubscriber(updateCh chan<- *SubStateUpdate, errCh chan<- error)

SetSubStateSubscriber writes to updateCh when any unit's substate changes. Although this writes to updateCh on every state change, the reported state may be more recent than the change that generated it (due to an unavoidable race in the systemd dbus interface). That is, this method provides a good way to keep a current view of all units' states, but is not guaranteed to show every state transition they go through. Furthermore, state changes will only be written to the channel with non-blocking writes. If updateCh is full, it attempts to write an error to errCh; if errCh is full, the error passes silently.

func (*Conn) SetUnitProperties 

func (c *Conn) SetUnitProperties(name string, runtime bool, properties ...Property) error

SetUnitProperties() may be used to modify certain unit properties at runtime. Not all properties may be changed at runtime, but many resource management settings (primarily those in systemd.cgroup(5)) may. The changes are applied instantly, and stored on disk for future boots, unless runtime is true, in which case the settings only apply until the next reboot. name is the name of the unit to modify. properties are the settings to set, encoded as an array of property name and value pairs.

func (*Conn) StartTransientUnit 

func (c *Conn) StartTransientUnit(name string, mode string, properties []Property, ch chan<- string) (int, error)

StartTransientUnit() may be used to create and start a transient unit, which will be released as soon as it is not running or referenced anymore or the system is rebooted. name is the unit name including suffix, and must be unique. mode is the same as in StartUnit(), properties contains properties of the unit.

func (*Conn) StartUnit 

func (c *Conn) StartUnit(name string, mode string, ch chan<- string) (int, error)

StartUnit enqueues a start job and depending jobs, if any (unless otherwise specified by the mode string).

Takes the unit to activate, plus a mode string. The mode needs to be one of replace, fail, isolate, ignore-dependencies, ignore-requirements. If "replace" the call will start the unit and its dependencies, possibly replacing already queued jobs that conflict with this. If "fail" the call will start the unit and its dependencies, but will fail if this would change an already queued job. If "isolate" the call will start the unit in question and terminate all units that aren't dependencies of it. If "ignore-dependencies" it will start a unit but ignore all its dependencies. If "ignore-requirements" it will start a unit but only ignore the requirement dependencies. It is not recommended to make use of the latter two options.

If the provided channel is non-nil, a result string will be sent to it upon job completion: one of done, canceled, timeout, failed, dependency, skipped. done indicates successful execution of a job. canceled indicates that a job has been canceled before it finished execution. timeout indicates that the job timeout was reached. failed indicates that the job failed. dependency indicates that a job this job has been depending on failed and the job hence has been removed too. skipped indicates that a job was skipped because it didn't apply to the units current state.

If no error occurs, the ID of the underlying systemd job will be returned. There does exist the possibility for no error to be returned, but for the returned job ID to be 0. In this case, the actual underlying ID is not 0 and this datapoint should not be considered authoritative.

If an error does occur, it will be returned to the user alongside a job ID of 0.

func (*Conn) StopUnit 

func (c *Conn) StopUnit(name string, mode string, ch chan<- string) (int, error)

StopUnit is similar to StartUnit but stops the specified unit rather than starting it.

func (*Conn) Subscribe 

func (c *Conn) Subscribe() error

Subscribe sets up this connection to subscribe to all systemd dbus events. This is required before calling SubscribeUnits. When the connection closes systemd will automatically stop sending signals so there is no need to explicitly call Unsubscribe().

func (*Conn) SubscribeUnits 

func (c *Conn) SubscribeUnits(interval time.Duration) (<-chan map[string]*UnitStatus, <-chan error)

Returns two unbuffered channels which will receive all changed units every interval. Deleted units are sent as nil.

func (*Conn) SubscribeUnitsCustom 

func (c *Conn) SubscribeUnitsCustom(interval time.Duration, buffer int, isChanged func(*UnitStatus, *UnitStatus) bool, filterUnit func(string) bool) (<-chan map[string]*UnitStatus, <-chan error)

SubscribeUnitsCustom is like SubscribeUnits but lets you specify the buffer size of the channels, the comparison function for detecting changes and a filter function for cutting down on the noise that your channel receives.

func (*Conn) TryRestartUnit 

func (c *Conn) TryRestartUnit(name string, mode string, ch chan<- string) (int, error)

TryRestartUnit is like RestartUnit, except that a service that isn't running is not affected by the restart.

func (*Conn) Unsubscribe 

func (c *Conn) Unsubscribe() error

Unsubscribe this connection from systemd dbus events.

type DisableUnitFileChange 

type DisableUnitFileChange struct {
	Type        string // Type of the change (one of symlink or unlink)
	Filename    string // File name of the symlink
	Destination string // Destination of the symlink
}

type EnableUnitFileChange 

type EnableUnitFileChange struct {
	Type        string // Type of the change (one of symlink or unlink)
	Filename    string // File name of the symlink
	Destination string // Destination of the symlink
}

type LinkUnitFileChange 

type LinkUnitFileChange EnableUnitFileChange

type Property 

type Property struct {
	Name  string
	Value dbus.Variant
}

func PropAfter 

func PropAfter(units ...string) Property

PropAfter sets the After unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#After=

func PropBefore 

func PropBefore(units ...string) Property

PropBefore sets the Before unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#Before=

func PropBindsTo 

func PropBindsTo(units ...string) Property

PropBindsTo sets the BindsTo unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#BindsTo=

func PropBoundBy 

func PropBoundBy(units ...string) Property

PropBoundBy sets the BoundBy unit property. See http://www.freedesktop.org/software/systemd/main/systemd.unit.html#BoundBy=

func PropConflictedBy 

func PropConflictedBy(units ...string) Property

PropConflictedBy sets the ConflictedBy unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#ConflictedBy=

func PropConflicts 

func PropConflicts(units ...string) Property

PropConflicts sets the Conflicts unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#Conflicts=

func PropDescription 

func PropDescription(desc string) Property

PropDescription sets the Description unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit#Description=

func PropExecStart 

func PropExecStart(command []string, uncleanIsFailure bool) Property

PropExecStart sets the ExecStart service property. The first argument is a slice with the binary path to execute followed by the arguments to pass to the executed command. See http://www.freedesktop.org/software/systemd/man/systemd.service.html#ExecStart=

func PropOnFailure 

func PropOnFailure(units ...string) Property

PropOnFailure sets the OnFailure unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#OnFailure=

func PropPropagatesReloadTo 

func PropPropagatesReloadTo(units ...string) Property

PropPropagatesReloadTo sets the PropagatesReloadTo unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#PropagatesReloadTo=

func PropRemainAfterExit 

func PropRemainAfterExit(b bool) Property

PropRemainAfterExit sets the RemainAfterExit service property. See http://www.freedesktop.org/software/systemd/man/systemd.service.html#RemainAfterExit=

func PropRequiredBy 

func PropRequiredBy(units ...string) Property

PropRequiredBy sets the RequiredBy unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#RequiredBy=

func PropRequiredByOverridable 

func PropRequiredByOverridable(units ...string) Property

PropRequiredByOverridable sets the RequiredByOverridable unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#RequiredByOverridable=

func PropRequires 

func PropRequires(units ...string) Property

PropRequires sets the Requires unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#Requires=

func PropRequiresMountsFor 

func PropRequiresMountsFor(units ...string) Property

PropRequiresMountsFor sets the RequiresMountsFor unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#RequiresMountsFor=

func PropRequiresOverridable 

func PropRequiresOverridable(units ...string) Property

PropRequiresOverridable sets the RequiresOverridable unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#RequiresOverridable=

func PropRequisite 

func PropRequisite(units ...string) Property

PropRequisite sets the Requisite unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#Requisite=

func PropRequisiteOverridable 

func PropRequisiteOverridable(units ...string) Property

PropRequisiteOverridable sets the RequisiteOverridable unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#RequisiteOverridable=

func PropSlice 

func PropSlice(slice string) Property

PropSlice sets the Slice unit property. See http://www.freedesktop.org/software/systemd/man/systemd.resource-control.html#Slice=

func PropTriggeredBy 

func PropTriggeredBy(units ...string) Property

PropTriggeredBy sets the TriggeredBy unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#TriggeredBy=

func PropTriggers 

func PropTriggers(units ...string) Property

PropTriggers sets the Triggers unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#Triggers=

func PropWantedBy 

func PropWantedBy(units ...string) Property

PropWantedBy sets the WantedBy unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#WantedBy=

func PropWants 

func PropWants(units ...string) Property

PropWants sets the Wants unit property. See http://www.freedesktop.org/software/systemd/man/systemd.unit.html#Wants=

type PropertyCollection 

type PropertyCollection struct {
	Name       string
	Properties []Property
}

type SubStateUpdate 

type SubStateUpdate struct {
	UnitName string
	SubState string
}

type SubscriptionSet 

type SubscriptionSet struct {
	// contains filtered or unexported fields
}

SubscriptionSet returns a subscription set which is like conn.Subscribe but can filter to only return events for a set of units.

func (SubscriptionSet) Add 

func (s SubscriptionSet) Add(value string)

func (SubscriptionSet) Contains 

func (s SubscriptionSet) Contains(value string) (exists bool)

func (SubscriptionSet) Length 

func (s SubscriptionSet) Length() int

func (SubscriptionSet) Remove 

func (s SubscriptionSet) Remove(value string)

func (*SubscriptionSet) Subscribe 

func (s *SubscriptionSet) Subscribe() (<-chan map[string]*UnitStatus, <-chan error)

Subscribe starts listening for dbus events for all of the units in the set. Returns channels identical to conn.SubscribeUnits.

func (SubscriptionSet) Values 

func (s SubscriptionSet) Values() (values []string)

type UnitStatus 

type UnitStatus struct {
	Name        string          // The primary unit name as string
	Description string          // The human readable description string
	LoadState   string          // The load state (i.e. whether the unit file has been loaded successfully)
	ActiveState string          // The active state (i.e. whether the unit is currently started or not)
	SubState    string          // The sub state (a more fine-grained version of the active state that is specific to the unit type, which the active state is not)
	Followed    string          // A unit that is being followed in its state by this unit, if there is any, otherwise the empty string.
	Path        dbus.ObjectPath // The unit object path
	JobId       uint32          // If there is a job queued for the job unit the numeric job id, 0 otherwise
	JobType     string          // The job type as string
	JobPath     dbus.ObjectPath // The job object path
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.