endpoint

Documentation

Index

• Constants
• type Endpoint
• type HTTPWSconfig
• type HTTPWSendPoint
  • func (e *HTTPWSendPoint) ID() string
  • func (e *HTTPWSendPoint) Init(listener chan transports.Message) error
  • func (e *HTTPWSendPoint) SetOption(name string, value interface{}) error
  • func (e *HTTPWSendPoint) Transport() transports.Transport
• type SubPubEndpoint
  • func (sp *SubPubEndpoint) ID() string
  • func (sp *SubPubEndpoint) Init(listener chan transports.Message) error
  • func (sp *SubPubEndpoint) SetOption(name string, value interface{}) error
  • func (sp *SubPubEndpoint) Transport() transports.Transport

Constants

const (
	OptionListenHost      = "listenHost"
	OptionListenPort      = "listenPort"
	OptionTLSdomain       = "tlsDomain"
	OptionTLSdirCert      = "tlsDirCert"
	OptionTLSconfig       = "tlsConfig"
	OptionMetricsInterval = "metricsInterval"
	OptionSetMode         = "setMode"

	ModeHTTPWS   = 0
	ModeHTTPonly = 1
	ModeWSonly   = 2
)

const (
	OptionPrivKey      = "setPrivKey"
	OptionTopic        = "setTopic"
	OptionID           = "setID"
	OptionBootnodes    = "setBootnodes"
	OptionTransportKey = "setTransportKey"
)

Types

type Endpoint

type Endpoint interface {
	Init(listener chan transports.Message) error
	SetOption(name string, value interface{}) error
	Transport() transports.Transport
	ID() string
}

Endpoint represents a valid Endpoint for the multirpc stack

type HTTPWSconfig

type HTTPWSconfig struct {
	ListenHost string
	ListenPort int32
	TLSdomain  string
	TLSdirCert string
	Mode       int8 // Modes available: 0:HTTP+WS, 1:HTTP, 2:WS
	TLSconfig  *tls.Config
	Metrics    *metrics.Metrics
}

type HTTPWSendPoint

type HTTPWSendPoint struct {
	Proxy        *mhttp.Proxy
	MetricsAgent *metrics.Agent
	// contains filtered or unexported fields
}

HTTPWSendPoint handles an HTTP + Websocket connection (client chooses).

func (*HTTPWSendPoint) ID

func (e *HTTPWSendPoint) ID() string

ID returns the name of the transport implemented on the endpoint

func (*HTTPWSendPoint) Init

func (e *HTTPWSendPoint) Init(listener chan transports.Message) error

Init creates a new websockets/http mixed endpoint

func (*HTTPWSendPoint) SetOption

func (e *HTTPWSendPoint) SetOption(name string, value interface{}) error

SetOption configures a endpoint option, valid options are: listenHost:string, listenPort:int32, tlsDomain:string, tlsDirCert:string, metricsInterval:int

func (*HTTPWSendPoint) Transport

func (e *HTTPWSendPoint) Transport() transports.Transport

Transport returns the transport used for this endpoint

type SubPubEndpoint

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

func (*SubPubEndpoint) ID

func (sp *SubPubEndpoint) ID() string

func (*SubPubEndpoint) Init

func (sp *SubPubEndpoint) Init(listener chan transports.Message) error

func (*SubPubEndpoint) SetOption

func (sp *SubPubEndpoint) SetOption(name string, value interface{}) error

func (*SubPubEndpoint) Transport

func (sp *SubPubEndpoint) Transport() transports.Transport