stream_forwarding

Documentation

Index

• Constants
• Variables
• type Config
  • func (m *Config) CloneMessageVT() proto.Message
  • func (m *Config) CloneVT() *Config
  • func (*Config) Descriptor() ([]byte, []int)
  • func (this *Config) EqualMessageVT(thatMsg proto.Message) bool
  • 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) GetProtocolId() string
  • func (x *Config) GetTargetMultiaddr() 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) ParseTargetMultiaddr() (ma.Multiaddr, 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, bus bus.Bus, conf *Config) (*Controller, error)
  • 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 DialResolver
  • func NewDialResolver(le *logrus.Entry, bus bus.Bus, ma ma.Multiaddr) (*DialResolver, error)
  • func (r *DialResolver) Resolve(ctx context.Context, handler directive.ResolverHandler) error
• type Factory
  • func NewFactory(bus bus.Bus) *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
• type MountedStreamHandler
  • func NewMountedStreamHandler(le *logrus.Entry, bus bus.Bus, dialMa ma.Multiaddr) (*MountedStreamHandler, error)
  • func (m *MountedStreamHandler) HandleMountedStream(ctx context.Context, strm link.MountedStream) error

Constants

const ConfigID = ControllerID

ConfigID is the string used to identify this config object.

const ControllerID = "bifrost/stream/forwarding"

ControllerID identifies the forwarding 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_stream_forwarding_forwarding_proto protoreflect.FileDescriptor

var Version = semver.MustParse("0.0.1")

Version is the controller version.

Types

type Config

type Config struct {

	// PeerId is the peer ID to forward for.
	// Can be empty.
	PeerId string `protobuf:"bytes,1,opt,name=peer_id,json=peerId,proto3" json:"peer_id,omitempty"`
	// ProtocolId is the protocol ID to forward for.
	ProtocolId string `protobuf:"bytes,2,opt,name=protocol_id,json=protocolId,proto3" json:"protocol_id,omitempty"`
	// TargetMultiaddr is the target multiaddress to dial.
	TargetMultiaddr string `protobuf:"bytes,3,opt,name=target_multiaddr,json=targetMultiaddr,proto3" json:"target_multiaddr,omitempty"`
	// contains filtered or unexported fields
}

Config configures the forwarding controller.

func (*Config) CloneMessageVT

func (m *Config) CloneMessageVT() 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) EqualMessageVT

func (this *Config) EqualMessageVT(thatMsg proto.Message) bool

func (*Config) EqualVT

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

func (*Config) EqualsConfig

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

EqualsConfig checks if the config is equal to another.

func (*Config) GetConfigID

func (c *Config) GetConfigID() string

GetConfigID returns the unique string for this configuration type. This string is stored with the encoded config.

func (*Config) GetPeerId

func (x *Config) GetPeerId() string

func (*Config) GetProtocolId

func (x *Config) GetProtocolId() string

func (*Config) GetTargetMultiaddr

func (x *Config) GetTargetMultiaddr() 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) ParseTargetMultiaddr

func (c *Config) ParseTargetMultiaddr() (ma.Multiaddr, error)

ParseTargetMultiaddr parses the multiaddress.

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. This is a cursory validation to see if the values "look correct."

type Controller

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

Controller implements the forwarding controller. The controller handles HandleMountedStream directives by dialing a target multiaddress.

func NewController

func NewController(
	le *logrus.Entry,
	bus bus.Bus,
	conf *Config,
) (*Controller, error)

NewController constructs a new forwarding controller.

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 forwarding 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 DialResolver

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

DialResolver resolves HandleMountedStream by dialing a multiaddr.

func NewDialResolver

func NewDialResolver(le *logrus.Entry, bus bus.Bus, ma ma.Multiaddr) (*DialResolver, error)

NewDialResolver constructs a new dial resolver.

func (*DialResolver) Resolve

func (r *DialResolver) Resolve(ctx context.Context, handler directive.ResolverHandler) error

Resolve resolves the values, emitting them to the handler.

type Factory

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

Factory constructs a forwarding controller

func NewFactory

func NewFactory(bus bus.Bus) *Factory

NewFactory builds a forwarding 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.

type MountedStreamHandler

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

MountedStreamHandler implements the mounted stream handler.

func NewMountedStreamHandler

func NewMountedStreamHandler(le *logrus.Entry, bus bus.Bus, dialMa ma.Multiaddr) (*MountedStreamHandler, error)

NewMountedStreamHandler constructs the mounted stream handler.

func (*MountedStreamHandler) HandleMountedStream

func (m *MountedStreamHandler) HandleMountedStream(
	ctx context.Context,
	strm link.MountedStream,
) error

HandleMountedStream handles an incoming mounted stream. Any returned error indicates the stream should be closed. This function should return as soon as possible, and start additional goroutines to manage the lifecycle of the stream.