group

Documentation

Index

• func Adapt(rpcClient rpc_client.Client) group.Plugin
• func NewClient(socketPath string) (group.Plugin, error)
• type CommitGroupRequest
• type CommitGroupResponse
• type DescribeGroupRequest
• type DescribeGroupResponse
• type DestroyGroupRequest
• type DestroyGroupResponse
• type FreeGroupRequest
• type FreeGroupResponse
• type Group
  • func PluginServer(p group.Plugin) *Group
  • func (p *Group) CommitGroup(_ *http.Request, req *CommitGroupRequest, resp *CommitGroupResponse) error
  • func (p *Group) DescribeGroup(_ *http.Request, req *DescribeGroupRequest, resp *DescribeGroupResponse) error
  • func (p *Group) DestroyGroup(_ *http.Request, req *DestroyGroupRequest, resp *DestroyGroupResponse) error
  • func (p *Group) ExampleProperties() *types.Any
  • func (p *Group) FreeGroup(_ *http.Request, req *FreeGroupRequest, resp *FreeGroupResponse) error
  • func (p *Group) ImplementedInterface() spi.InterfaceSpec
  • func (p *Group) InspectGroups(_ *http.Request, req *InspectGroupsRequest, resp *InspectGroupsResponse) error
  • func (p *Group) VendorInfo() *spi.VendorInfo
• type InspectGroupsRequest
• type InspectGroupsResponse

Functions

func Adapt

func Adapt(rpcClient rpc_client.Client) group.Plugin

Adapt returns a group Plugin implementation based on given rpc client. Assumption here is that the rpcClient has been verified to support the group plugin RPC interface.

func NewClient

func NewClient(socketPath string) (group.Plugin, error)

NewClient returns a plugin interface implementation connected to a remote plugin

Types

type CommitGroupRequest

type CommitGroupRequest struct {
	Spec    group.Spec
	Pretend bool
}

CommitGroupRequest is the rpc wrapper for input to commit a group

type CommitGroupResponse

type CommitGroupResponse struct {
	Details string
}

CommitGroupResponse is the rpc wrapper for the results to commit a group

type DescribeGroupRequest

type DescribeGroupRequest struct {
	ID group.ID
}

DescribeGroupRequest is the rpc wrapper for the input to inspect a group

type DescribeGroupResponse

type DescribeGroupResponse struct {
	Description group.Description
}

DescribeGroupResponse is the rpc wrapper for the results from inspecting a group

type DestroyGroupRequest

type DestroyGroupRequest struct {
	ID group.ID
}

DestroyGroupRequest is the rpc wrapper for the input to destroy a group

type DestroyGroupResponse

type DestroyGroupResponse struct {
	OK bool
}

DestroyGroupResponse is the rpc wrapper for the output from destroying a group

type FreeGroupRequest

type FreeGroupRequest struct {
	ID group.ID
}

FreeGroupRequest is the rpc wrapper for input to free a group

type FreeGroupResponse

type FreeGroupResponse struct {
	OK bool
}

FreeGroupResponse is the rpc wrapper for the results to free a group

type Group

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

Group the exported type needed to conform to json-rpc call convention

func PluginServer

func PluginServer(p group.Plugin) *Group

PluginServer returns a RPCService that conforms to the net/rpc rpc call convention.

func (*Group) CommitGroup

func (p *Group) CommitGroup(_ *http.Request, req *CommitGroupRequest, resp *CommitGroupResponse) error

CommitGroup is the rpc method to commit a group

func (*Group) DescribeGroup

func (p *Group) DescribeGroup(_ *http.Request, req *DescribeGroupRequest, resp *DescribeGroupResponse) error

DescribeGroup is the rpc method to describe a group

func (*Group) DestroyGroup

func (p *Group) DestroyGroup(_ *http.Request, req *DestroyGroupRequest, resp *DestroyGroupResponse) error

DestroyGroup is the rpc method to destroy a group

func (*Group) ExampleProperties

func (p *Group) ExampleProperties() *types.Any

ExampleProperties returns an example properties used by the plugin

func (*Group) FreeGroup

func (p *Group) FreeGroup(_ *http.Request, req *FreeGroupRequest, resp *FreeGroupResponse) error

FreeGroup is the rpc method to free a group

func (*Group) ImplementedInterface

func (p *Group) ImplementedInterface() spi.InterfaceSpec

ImplementedInterface returns the interface implemented by this RPC service.

func (*Group) InspectGroups

func (p *Group) InspectGroups(_ *http.Request, req *InspectGroupsRequest, resp *InspectGroupsResponse) error

InspectGroups is the rpc method to inspect groups

func (*Group) VendorInfo

func (p *Group) VendorInfo() *spi.VendorInfo

VendorInfo returns a metadata object about the plugin, if the plugin implements it. See plugin.Vendor

type InspectGroupsRequest

type InspectGroupsRequest struct {
}

InspectGroupsRequest is the rpc wrapper for the input to inspect groups

type InspectGroupsResponse

type InspectGroupsResponse struct {
	Groups []group.Spec
}

InspectGroupsResponse is the rpc wrapper for the output from inspecting groups