agent

Documentation

Index

• type Agent
• type AttachAgentToNode
• type AttachAgentToNodeSingleton
  • func NewAttachAgentToNodeSingleton(peerID peer.ID) *AttachAgentToNodeSingleton
  • func (d *AttachAgentToNodeSingleton) AttachAgentToNodeID() peer.ID
  • func (d *AttachAgentToNodeSingleton) GetDebugVals() directive.DebugValues
  • func (d *AttachAgentToNodeSingleton) GetName() string
  • func (d *AttachAgentToNodeSingleton) GetValueOptions() directive.ValueOptions
  • func (d *AttachAgentToNodeSingleton) IsEquivalent(other directive.Directive) bool
  • func (d *AttachAgentToNodeSingleton) Superceeds(other directive.Directive) bool
  • func (d *AttachAgentToNodeSingleton) Validate() error

Types

type Agent

type Agent interface {
	// Peer indicates Agent is a Peer.
	peer.Peer
}

Agent is an identified process attached to a Node. The agent controller implements the agent interface. This is the end-user API/handle to an agent.

type AttachAgentToNode

type AttachAgentToNode interface {
	// Directive indicates AttachAgentToNode is a directive.
	directive.Directive

	// AttachAgentToNodeID returns a specific node ID we are looking for.
	// Cannot be empty.
	AttachAgentToNodeID() peer.ID
}

AttachAgentToNode is a directive to attach an agent to a node.

type AttachAgentToNodeSingleton

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

AttachAgentToNodeSingleton implements AttachAgentToNode with a peer ID constraint.

func NewAttachAgentToNodeSingleton

func NewAttachAgentToNodeSingleton(peerID peer.ID) *AttachAgentToNodeSingleton

NewAttachAgentToNodeSingleton constructs a new AttachAgentToNodeSingleton directive.

func (*AttachAgentToNodeSingleton) AttachAgentToNodeID

func (d *AttachAgentToNodeSingleton) AttachAgentToNodeID() peer.ID

AttachAgentToNodeID returns a specific peer ID node we are looking for. If empty, any node is matched.

func (*AttachAgentToNodeSingleton) GetDebugVals

func (d *AttachAgentToNodeSingleton) GetDebugVals() directive.DebugValues

GetDebugString returns the directive arguments stringified. This should be something like param1="test", param2="test". This is not necessarily unique, and is primarily intended for display.

func (*AttachAgentToNodeSingleton) GetName

func (d *AttachAgentToNodeSingleton) GetName() string

GetName returns the directive's type name. This is not necessarily unique, and is primarily intended for display.

func (*AttachAgentToNodeSingleton) GetValueOptions

func (d *AttachAgentToNodeSingleton) GetValueOptions() directive.ValueOptions

GetValueOptions returns options relating to value handling.

func (*AttachAgentToNodeSingleton) IsEquivalent

func (d *AttachAgentToNodeSingleton) IsEquivalent(other directive.Directive) bool

IsEquivalent checks if the other directive is equivalent. If two directives are equivalent, and the new directive does not superceed the old, then the new directive will be merged (de-duplicated) into the old.

func (*AttachAgentToNodeSingleton) Superceeds

func (d *AttachAgentToNodeSingleton) Superceeds(other directive.Directive) bool

Superceeds checks if the directive overrides another. The other directive will be canceled if superceded.

func (*AttachAgentToNodeSingleton) Validate

func (d *AttachAgentToNodeSingleton) Validate() error

Validate validates the directive. This is a cursory validation to see if the values "look correct."