peer_controller

Documentation

Index

• Constants
• Variables
• type Config
  • func NewConfigWithPrivKey(pk crypto.PrivKey) (*Config, error)
  • func (m *Config) CloneGenericVT() proto.Message
  • func (m *Config) CloneVT() *Config
  • func (*Config) Descriptor() ([]byte, []int)
  • func (this *Config) EqualVT(that *Config) bool
  • func (c *Config) EqualsConfig(c2 config.Config) bool
  • func (c *Config) GetConfigID() string
  • func (x *Config) GetPeerId() string
  • func (x *Config) GetPrivKey() string
  • func (x *Config) GetPubKey() string
  • func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)
  • func (m *Config) MarshalToVT(dAtA []byte) (int, error)
  • func (m *Config) MarshalVT() (dAtA []byte, err error)
  • func (c *Config) ParsePeerID() (peer.ID, error)
  • func (c *Config) ParsePrivateKey() (crypto.PrivKey, error)
  • func (c *Config) ParsePublicKey() (crypto.PubKey, error)
  • func (c *Config) ParseToPeer() (peer.Peer, error)
  • func (*Config) ProtoMessage()
  • func (x *Config) ProtoReflect() protoreflect.Message
  • func (x *Config) Reset()
  • func (m *Config) SizeVT() (n int)
  • func (x *Config) String() string
  • func (m *Config) UnmarshalVT(dAtA []byte) error
  • func (c *Config) Validate() error
• type Controller
  • func NewController(le *logrus.Entry, p peer.Peer) *Controller
  • func (c *Controller) Close() error
  • func (c *Controller) Execute(ctx context.Context) error
  • func (c *Controller) GetControllerInfo() *controller.Info
  • func (c *Controller) HandleDirective(ctx context.Context, di directive.Instance) ([]directive.Resolver, error)
• type Factory
  • func NewFactory() *Factory
  • func (t *Factory) Construct(conf config.Config, opts controller.ConstructOpts) (controller.Controller, error)
  • func (t *Factory) ConstructConfig() config.Config
  • func (t *Factory) GetConfigID() string
  • func (t *Factory) GetControllerID() string
  • func (t *Factory) GetVersion() semver.Version

Constants

const ConfigID = ControllerID

ConfigID is the identifier for the config type.

const ControllerID = "bifrost/peer/1"

ControllerID is the ID of the controller.

Variables

var (
	ErrInvalidLength        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflow          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group")
)

var File_github_com_aperturerobotics_bifrost_peer_controller_config_proto protoreflect.FileDescriptor

var Version = semver.MustParse("0.0.1")

Version is the version of the controller implementation.

Types

type Config

type Config struct {

	// PrivKey is the peer private key in either b58 or PEM format.
	// See confparse.MarshalPrivateKey.
	// If not set, the peer private key will be unavailable.
	PrivKey string `protobuf:"bytes,1,opt,name=priv_key,json=privKey,proto3" json:"priv_key,omitempty"`
	// PubKey is the peer public key.
	// Ignored if priv_key is set.
	PubKey string `protobuf:"bytes,2,opt,name=pub_key,json=pubKey,proto3" json:"pub_key,omitempty"`
	// PeerId is the peer identifier.
	// Ignored if priv_key or pub_key are set.
	// The peer ID should contain the public key.
	PeerId string `protobuf:"bytes,3,opt,name=peer_id,json=peerId,proto3" json:"peer_id,omitempty"`
	// contains filtered or unexported fields
}

Config is the peer controller config.

func NewConfigWithPrivKey

func NewConfigWithPrivKey(pk crypto.PrivKey) (*Config, error)

NewConfigWithPrivKey builds a new configuration with a private key

func (*Config) CloneGenericVT

func (m *Config) CloneGenericVT() proto.Message

func (*Config) CloneVT

func (m *Config) CloneVT() *Config

func (*Config) Descriptor

func (*Config) Descriptor() ([]byte, []int)

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) EqualVT

func (this *Config) EqualVT(that *Config) bool

func (*Config) EqualsConfig

func (c *Config) EqualsConfig(c2 config.Config) bool

EqualsConfig checks equality between two configs.

func (*Config) GetConfigID

func (c *Config) GetConfigID() string

GetConfigID returns the config identifier.

func (*Config) GetPeerId

func (x *Config) GetPeerId() string

func (*Config) GetPrivKey

func (x *Config) GetPrivKey() string

func (*Config) GetPubKey

func (x *Config) GetPubKey() string

func (*Config) MarshalToSizedBufferVT

func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Config) MarshalToVT

func (m *Config) MarshalToVT(dAtA []byte) (int, error)

func (*Config) MarshalVT

func (m *Config) MarshalVT() (dAtA []byte, err error)

func (*Config) ParsePeerID

func (c *Config) ParsePeerID() (peer.ID, error)

ParsePeerID parses the peer ID. may return nil.

func (*Config) ParsePrivateKey

func (c *Config) ParsePrivateKey() (crypto.PrivKey, error)

ParsePrivateKey parses the private key from the configuration. Returns nil, nil if unset.

func (*Config) ParsePublicKey

func (c *Config) ParsePublicKey() (crypto.PubKey, error)

ParsePublicKey parses the public key from the configuration. Returns nil, nil if unset.

func (*Config) ParseToPeer

func (c *Config) ParseToPeer() (peer.Peer, error)

ParseToPeer parses the fields and builds the corresponding Peer.

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) ProtoReflect

func (x *Config) ProtoReflect() protoreflect.Message

func (*Config) Reset

func (x *Config) Reset()

func (*Config) SizeVT

func (m *Config) SizeVT() (n int)

func (*Config) String

func (x *Config) String() string

func (*Config) UnmarshalVT

func (m *Config) UnmarshalVT(dAtA []byte) error

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the configuration.

type Controller

type Controller struct {
	// Peer is the underlying peer
	peer.Peer
	// contains filtered or unexported fields
}

Controller is the Peer controller. It implements peer.Peer as a controller. It implements a "localhost" loopback transport for the peer.

func NewController

func NewController(le *logrus.Entry, p peer.Peer) *Controller

NewController constructs a new peer controller. If privKey is nil, one will be generated.

func (*Controller) Close

func (c *Controller) Close() error

Close releases any resources used by the controller. Error indicates any issue encountered releasing.

func (*Controller) Execute

func (c *Controller) Execute(ctx context.Context) error

Execute executes the given controller. Returning nil ends execution. Returning an error triggers a retry with backoff.

func (*Controller) GetControllerInfo

func (c *Controller) GetControllerInfo() *controller.Info

GetControllerInfo returns information about the controller.

func (*Controller) HandleDirective

func (c *Controller) HandleDirective(
	ctx context.Context,
	di directive.Instance,
) ([]directive.Resolver, error)

HandleDirective asks if the handler can resolve the directive. If it can, it returns a resolver. If not, returns nil. Any exceptional errors are returned for logging. It is safe to add a reference to the directive during this call.

type Factory

type Factory struct {
}

Factory constructs a Peer controller.

func NewFactory

func NewFactory() *Factory

NewFactory builds a peer controller factory.

func (*Factory) Construct

func (t *Factory) Construct(
	conf config.Config,
	opts controller.ConstructOpts,
) (controller.Controller, error)

Construct constructs the associated controller given configuration.

func (*Factory) ConstructConfig

func (t *Factory) ConstructConfig() config.Config

ConstructConfig constructs an instance of the controller configuration.

func (*Factory) GetConfigID

func (t *Factory) GetConfigID() string

GetConfigID returns the configuration ID for the controller.

func (*Factory) GetControllerID

func (t *Factory) GetControllerID() string

GetControllerID returns the unique ID for the controller.

func (*Factory) GetVersion

func (t *Factory) GetVersion() semver.Version

GetVersion returns the version of this controller.