Documentation ¶
Index ¶
- Constants
- Variables
- type Config
- func (m *Config) CloneMessageVT() proto.Message
- func (m *Config) CloneVT() *Config
- func (*Config) Descriptor() ([]byte, []int)deprecated
- func (this *Config) EqualMessageVT(thatMsg proto.Message) bool
- func (this *Config) EqualVT(that *Config) bool
- func (c *Config) EqualsConfig(other config.Config) bool
- func (x *Config) GetAddr() string
- func (x *Config) GetCertFile() string
- func (x *Config) GetClientId() string
- func (c *Config) GetConfigID() string
- func (x *Config) GetKeyFile() string
- func (x *Config) GetWait() bool
- 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 (*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 (c *Controller) Close() error
- func (c *Controller) Execute(rctx context.Context) (rerr error)
- func (c *Controller) GetControllerInfo() *controller.Info
- func (c *Controller) HandleDirective(ctx context.Context, inst directive.Instance) ([]directive.Resolver, error)
- func (c *Controller) ServeHTTP(rw http.ResponseWriter, req *http.Request)
- type Factory
Constants ¶
const ConfigID = ControllerID
ConfigID is the string used to identify this config object.
const ControllerID = "bifrost/http/listener"
ControllerID is the controller ID.
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_http_listener_config_proto protoreflect.FileDescriptor
var Version = semver.MustParse("0.0.1")
Version is the version of this controller.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { // Addr is the address to listen. // // Example: 0.0.0.0:8080 Addr string `protobuf:"bytes,1,opt,name=addr,proto3" json:"addr,omitempty"` // ClientId is the client id to set on LookupHTTPHandler. ClientId string `protobuf:"bytes,2,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"` // CertFile is the path to the certificate file to use for https. // Can be unset to use HTTP. CertFile string `protobuf:"bytes,3,opt,name=cert_file,json=certFile,proto3" json:"cert_file,omitempty"` // KeyFile is the path to the key file to use for https. // Cannot be unset if cert_file is set. // Otherwise can be unset. KeyFile string `protobuf:"bytes,4,opt,name=key_file,json=keyFile,proto3" json:"key_file,omitempty"` // Wait indicates to wait for LookupHTTPHandler even if it becomes idle. // If false: returns 404 not found if LookupHTTPHandler becomes idle. Wait bool `protobuf:"varint,5,opt,name=wait,proto3" json:"wait,omitempty"` // contains filtered or unexported fields }
Config configures a http server that listens on a port.
Handles incoming requests with LookupHTTPHandler.
func (*Config) CloneMessageVT ¶ added in v0.15.6
func (*Config) Descriptor
deprecated
func (*Config) EqualMessageVT ¶ added in v0.15.6
func (*Config) EqualsConfig ¶
EqualsConfig checks if the config is equal to another.
func (*Config) GetCertFile ¶
func (*Config) GetClientId ¶
func (*Config) GetConfigID ¶
GetConfigID returns the unique string for this configuration type.
func (*Config) GetKeyFile ¶
func (*Config) MarshalToSizedBufferVT ¶
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) ProtoReflect ¶
func (x *Config) ProtoReflect() protoreflect.Message
func (*Config) UnmarshalVT ¶
type Controller ¶
type Controller struct {
// contains filtered or unexported fields
}
Controller listens for incoming HTTP connections on a port.
func NewController ¶
func NewController( le *logrus.Entry, srv *http.Server, ) *Controller
NewController constructs a new controller.
func NewControllerWithTLS ¶
func NewControllerWithTLS( le *logrus.Entry, srv *http.Server, certFile string, keyFile string, ) *Controller
NewControllerWithTLS constructs a new controller with TLS.
certFile is the path to the cert file keyFile is the path to the key file
func (*Controller) Close ¶
func (c *Controller) Close() error
Close releases any resources used by the controller.
func (*Controller) Execute ¶
func (c *Controller) Execute(rctx context.Context) (rerr error)
Execute executes the controller. Returning nil ends execution.
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, inst directive.Instance, ) ([]directive.Resolver, error)
HandleDirective asks if the handler can resolve the directive.
func (*Controller) ServeHTTP ¶
func (c *Controller) ServeHTTP(rw http.ResponseWriter, req *http.Request)
ServeHTTP serves HTTP using the handler.
Does nothing if no server or handler set.
type Factory ¶
type Factory struct {
// contains filtered or unexported fields
}
Factory constructs the http listener
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 ¶
ConstructConfig constructs an instance of the controller configuration.
func (*Factory) GetConfigID ¶
GetConfigID returns the configuration ID for the controller.
func (*Factory) GetControllerID ¶
GetControllerID returns the unique ID for the controller.
func (*Factory) GetVersion ¶
GetVersion returns the version of this controller.