relay

Documentation

Index

• Variables
• type Options
  • func ReadOptions(configFile *config.File) (*Options, error)
• type Service
  • func NewService(relayConfig *traffic.RelayOptions, trafficPlugins []traffic.Plugin) *Service
  • func (service *Service) Address() string
  • func (service *Service) Close() error
  • func (service *Service) HttpUrl() string
  • func (service *Service) Port() int
  • func (service *Service) Start(host string, port int) error
  • func (service *Service) WsUrl() string
• type ServiceOptions
  • func NewDefaultServiceOptions() *ServiceOptions
• type TcpKeepAliveListener
  • func (listener TcpKeepAliveListener) Accept() (net.Conn, error)

Variables

var MonitorPath = "/__relay__up__/"

Types

type Options

type Options struct {
	Service *ServiceOptions
	Relay   *traffic.RelayOptions
}

func ReadOptions

func ReadOptions(configFile *config.File) (*Options, error)

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service implements the relay service, exposing both the traffic handler and the monitoring page.

func NewService

func NewService(relayConfig *traffic.RelayOptions, trafficPlugins []traffic.Plugin) *Service

func (*Service) Address

func (service *Service) Address() string

func (*Service) Close

func (service *Service) Close() error

func (*Service) HttpUrl

func (service *Service) HttpUrl() string

func (*Service) Port

func (service *Service) Port() int

func (*Service) Start

func (service *Service) Start(host string, port int) error

func (*Service) WsUrl

func (service *Service) WsUrl() string

type ServiceOptions

type ServiceOptions struct {
	Port int // The port that the relay service should listen on.
}

ServiceOptions contains configuration options for the relay network service.

See also traffic.RelayOptions, which provides options for the actual relay functionality.

func NewDefaultServiceOptions

func NewDefaultServiceOptions() *ServiceOptions

type TcpKeepAliveListener

type TcpKeepAliveListener struct {
	*net.TCPListener
}

func (TcpKeepAliveListener) Accept

func (listener TcpKeepAliveListener) Accept() (net.Conn, error)