Documentation
¶
Index ¶
- type ErrInadequateCapability
- type Plugin
- func (p *Plugin) Acquire()
- func (p *Plugin) AddRefCount(count int)
- func (p *Plugin) BasePath() string
- func (p *Plugin) Client() *plugins.Client
- func (p *Plugin) FilterByCap(capability string) (*Plugin, error)
- func (p *Plugin) GetID() string
- func (p *Plugin) GetRefCount() int
- func (p *Plugin) GetSocket() string
- func (p *Plugin) GetTypes() []types.PluginInterfaceType
- func (p *Plugin) InitEmptySettings()
- func (p *Plugin) InitSpec(execRoot string) (*specs.Spec, error)
- func (p *Plugin) IsEnabled() bool
- func (p *Plugin) IsV1() bool
- func (p *Plugin) Name() string
- func (p *Plugin) Release()
- func (p *Plugin) Set(args []string) error
- func (p *Plugin) SetPClient(client *plugins.Client)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrInadequateCapability ¶
type ErrInadequateCapability struct {
// contains filtered or unexported fields
}
ErrInadequateCapability indicates that the plugin did not have the requested capability.
func (ErrInadequateCapability) Error ¶
func (e ErrInadequateCapability) Error() string
type Plugin ¶
type Plugin struct {
PluginObj types.Plugin `json:"plugin"` // todo: embed struct
PropagatedMount string // TODO: make private
Rootfs string // TODO: make private
Config digest.Digest
Blobsums []digest.Digest
// contains filtered or unexported fields
}
Plugin represents an individual plugin.
func (*Plugin) Acquire ¶
func (p *Plugin) Acquire()
Acquire increments the plugin's reference count This should be followed up by `Release()` when the plugin is no longer in use.
func (*Plugin) AddRefCount ¶
AddRefCount adds to reference count.
func (*Plugin) BasePath ¶
BasePath returns the path to which all paths returned by the plugin are relative to. For Plugin objects this returns the host path of the plugin container's rootfs.
func (*Plugin) FilterByCap ¶
FilterByCap query the plugin for a given capability.
func (*Plugin) GetRefCount ¶
GetRefCount returns the reference count.
func (*Plugin) GetTypes ¶
func (p *Plugin) GetTypes() []types.PluginInterfaceType
GetTypes returns the interface types of a plugin.
func (*Plugin) InitEmptySettings ¶
func (p *Plugin) InitEmptySettings()
InitEmptySettings initializes empty settings for a plugin.
func (*Plugin) Release ¶
func (p *Plugin) Release()
Release decrements the plugin's reference count This should only be called when the plugin is no longer in use, e.g. with via `Acquire()` or getter.Get("name", "type", plugingetter.ACQUIRE)
func (*Plugin) SetPClient ¶
SetPClient set the plugin client.
Source Files