transport

package

v0.5.2 Latest Latest Go to latest Published: Apr 11, 2020 License: Apache-2.0 Imports: 16 Imported by: 0

Details

This section is empty.

View Source

var (
	// ErrListenerIsOff ...
	ErrListenerIsOff = errors.New("listener is off")
)

This section is empty.

type Config struct {
	// AuthManager
	AuthManager *auth.Manager

	Host string
	// Port tcp port to listen on
	Port string
}

Config is base configuration object used by all transports

type ConfigTCP struct {
	Scheme string
	TLS    *tls.Config
	// contains filtered or unexported fields
}

ConfigTCP configuration of tcp transport

func NewConfigTCP(transport *Config) *ConfigTCP

NewConfigTCP allocate new transport config for tcp transport Use of this function is preferable instead of direct allocation of ConfigTCP

type ConfigWS struct {
	CertFile string
	KeyFile  string
	Path     string
	// contains filtered or unexported fields
}

ConfigWS listener object for websocket server

func NewConfigWS(transport *Config) *ConfigWS

NewConfigWS allocate new transport config for websocket transport Use of this function is preferable instead of direct allocation of ConfigWS

type Conn interface {
	net.Conn
}

Conn is wrapper to net.Conn implemented to encapsulate bytes statistic

type Handler interface {
	OnConnection(Conn, *auth.Manager) error
}

Handler ...

type InternalConfig struct {
	Handler
	AcceptPool types.Pool
	Metrics    metrics.Bytes
}

InternalConfig used by server implementation to configure internal specific needs

type Provider interface {
	Protocol() string
	Serve() error
	Close() error
	Port() string
	Ready() error
	Alive() error
}

Provider is interface that all of transports must implement

func NewTCP(config *ConfigTCP, internal *InternalConfig) (Provider, error)

NewTCP create new tcp transport

func NewWS(config *ConfigWS, internal *InternalConfig) (Provider, error)

NewWS create new websocket transport