bifrost_http_listener

package
v0.40.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 23, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source 
const ConfigID = ControllerID

ConfigID is the string used to identify this config object.

View Source 
const ControllerID = "bifrost/http/listener"

ControllerID is the controller ID.

Variables

View Source 
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:"clientId,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:"certFile,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:"keyFile,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 NewConfig 

func NewConfig(addr, clientID string) *Config

NewConfig constructs a new listener config.

func (*Config) CloneMessageVT added in v0.15.6 

func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Config) CloneVT 

func (m *Config) CloneVT() *Config

func (*Config) EqualMessageVT added in v0.15.6 

func (this *Config) EqualMessageVT(thatMsg any) bool

func (*Config) EqualVT 

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

func (*Config) EqualsConfig 

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

EqualsConfig checks if the config is equal to another.

func (*Config) GetAddr 

func (x *Config) GetAddr() string

func (*Config) GetCertFile 

func (x *Config) GetCertFile() string

func (*Config) GetClientId 

func (x *Config) GetClientId() string

func (*Config) GetConfigID 

func (c *Config) GetConfigID() string

GetConfigID returns the unique string for this configuration type.

func (*Config) GetKeyFile 

func (x *Config) GetKeyFile() string

func (*Config) GetWait 

func (x *Config) GetWait() bool

func (*Config) MarshalJSON added in v0.29.0 

func (x *Config) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Config to JSON.

func (*Config) MarshalProtoJSON added in v0.29.0 

func (x *Config) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Config message to JSON.

func (*Config) MarshalProtoText added in v0.29.2 

func (x *Config) MarshalProtoText() 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) ProtoMessage 

func (*Config) ProtoMessage()

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) UnmarshalJSON added in v0.29.0 

func (x *Config) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Config from JSON.

func (*Config) UnmarshalProtoJSON added in v0.29.0 

func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Config message from JSON.

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 {
	// 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 NewFactory 

func NewFactory(bus bus.Bus) *Factory

NewFactory builds the factory.

func (*Factory) Construct 

func (t *Factory) Construct(
	ctx context.Context,
	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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.