options

package

v2.0.0-beta3 Latest Latest Go to latest Published: May 27, 2025 License: Apache-2.0 Imports: 3 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/trickstercache/trickster

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	// DefaultProxyListenPort is the default port that the HTTP frontend will listen on
	DefaultProxyListenPort = 8480
	// DefaultProxyListenAddress is the default address that the HTTP frontend will listen on
	DefaultProxyListenAddress = ""

	// DefaultTLSProxyListenPort is the default port that the TLS frontend endpoint will listen on
	DefaultTLSProxyListenPort = 8483
	// DefaultTLSProxyListenAddress is the default address that the TLS frontend endpoint will listen on
	DefaultTLSProxyListenAddress = ""

	// DefaultReadHeaderTimeout is the default amount of time allowed to read request headers by the frontend proxy server
	DefaultReadHeaderTimeout = 10 * time.Second
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Options ¶

type Options struct {
	// ListenAddress is IP address for the main http listener for the application
	ListenAddress string `yaml:"listen_address,omitempty"`
	// ListenPort is TCP Port for the main http listener for the application
	ListenPort int `yaml:"listen_port,omitempty"`
	// TLSListenAddress is IP address for the tls  http listener for the application
	TLSListenAddress string `yaml:"tls_listen_address,omitempty"`
	// TLSListenPort is the TCP Port for the tls http listener for the application
	TLSListenPort int `yaml:"tls_listen_port,omitempty"`
	// ConnectionsLimit indicates how many concurrent front end connections trickster will handle at any time
	ConnectionsLimit int `yaml:"connections_limit,omitempty"`
	// ReadHeaderTimeout is the amount of time allowed to read request headers.
	ReadHeaderTimeout time.Duration `yaml:"read_header_timeout,omitempty"`
	// ServeTLS indicates whether to listen and serve on the TLS port, meaning
	// at least one backend options has a valid certificate and key file configured.
	ServeTLS bool `yaml:"-"`
}

FrontendConfig is a collection of configurations for the main http frontend for the application

func New ¶

func New() *Options

New returns a new Frontend Options with default values

func (*Options) Clone ¶

func (o *Options) Clone() *Options

Clone returns a clone of the Options

func (*Options) Equal ¶

func (o *Options) Equal(o2 *Options) bool

Equal returns true if the FrontendConfigs are identical in value.

func (*Options) Validate ¶

func (o *Options) Validate(f TLSConfigFunc) error

type TLSConfigFunc ¶

type TLSConfigFunc func() (*tls.Config, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL