Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func New ¶
New constructs a new net.Listener using a set of options.
If Next is set, that listener is decorated with connection limiting and other options specfied in Options. Otherwise, a new net.Listener is created, and that new listener is decorated. Note that in the case where this function creates a new net.Listener, that listener will be occupying a port and should be cleaned up via Close() if higher level errors occur.
Types ¶
type Options ¶
type Options struct {
// Logger is the go-kit logger to use for output. If unset, logging.DefaultLogger() is used.
Logger log.Logger
// MaxConnections is the maximum number of active connections the listener will permit. If this
// value is not positive, there is no limit to the number of connections.
MaxConnections int
// Rejected is is incremented each time the listener rejects a connection. If unset, a go-kit discard Counter is used.
Rejected xmetrics.Adder
// Active is updated to reflect the current number of active connections. If unset, a go-kit discard Gauge is used.
Active xmetrics.Adder
// Network is the network to listen on. This value is only used if Next is unset. Defaults to "tcp" if unset.
Network string
// Address is the address to listen on. This value is only used if Next is unset. Defaults to ":http" if unset.
Address string
// Next is the net.Listener to decorate. If this field is set, Network and Address are ignored.
Next net.Listener
Config *tls.Config
}
Options defines the available options for configuring a listener
Click to show internal directories.
Click to hide internal directories.