server

Documentation

Index

• Variables
• type Config
• type HybridConnector
  • func NewDefaultHybridConnector(qc *quic.Connector, tc *rpc.TCPConnector) HybridConnector
  • func (c HybridConnector) DialContext(ctx context.Context, tlsConfig *tls.Config, address string) (_ rpc.ConnectorConn, err error)
  • func (c *HybridConnector) SetQUICTransferRate(rate memory.Size)
  • func (c *HybridConnector) SetTCPTransferRate(rate memory.Size)
• type Server
  • func New(log *zap.Logger, tlsOptions *tlsopts.Options, config Config) (_ *Server, err error)
  • func (p *Server) Addr() net.Addr
  • func (p *Server) Close() error
  • func (p *Server) DRPC() *drpcmux.Mux
  • func (p *Server) Identity() *identity.FullIdentity
  • func (p *Server) PrivateAddr() net.Addr
  • func (p *Server) PrivateDRPC() *drpcmux.Mux
  • func (p *Server) Run(ctx context.Context) (err error)

Variables

var (

	// Error is a pkg/server error.
	Error = errs.Class("server error")
)

Types

type Config

type Config struct {
	tlsopts.Config
	Address        string `user:"true" help:"public address to listen on" default:":7777"`
	PrivateAddress string `user:"true" help:"private address to listen on" default:"127.0.0.1:7778"`
	DisableQUIC    bool   `help:"disable QUIC listener on a server" hidden:"true" default:"false"`

	DisableTCPTLS   bool `help:"disable TCP/TLS listener on a server" internal:"true"`
	DebugLogTraffic bool `hidden:"true" default:"false"` // Deprecated
}

Config holds server specific configuration parameters.

type HybridConnector

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

HybridConnector implements a dialer that creates a connection using either quic or tcp.

func NewDefaultHybridConnector

func NewDefaultHybridConnector(qc *quic.Connector, tc *rpc.TCPConnector) HybridConnector

NewDefaultHybridConnector instantiates a new instance of HybridConnector with provided quic and tcp connectors. If a nil value is provided for either connector, a default connector will be created instead. See func DialContext for more details.

func (HybridConnector) DialContext

func (c HybridConnector) DialContext(ctx context.Context, tlsConfig *tls.Config, address string) (_ rpc.ConnectorConn, err error)

DialContext creates a connection using either quic or tcp. It tries to dial through both connector and returns the first established connection. If both connections are established, it will return quic connection. An error is returned if both connector failed.

func (*HybridConnector) SetQUICTransferRate

func (c *HybridConnector) SetQUICTransferRate(rate memory.Size)

SetQUICTransferRate returns a connector with the given transfer rate.

func (*HybridConnector) SetTCPTransferRate

func (c *HybridConnector) SetTCPTransferRate(rate memory.Size)

SetTCPTransferRate returns a connector with the given transfer rate.

type Server

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

Server represents a bundle of services defined by a specific ID. Examples of servers are the satellite, the storagenode, and the uplink.

func New

func New(log *zap.Logger, tlsOptions *tlsopts.Options, config Config) (_ *Server, err error)

New creates a Server out of an Identity, a net.Listener, and interceptors.

func (*Server) Addr

func (p *Server) Addr() net.Addr

Addr returns the server's public listener address.

func (*Server) Close

func (p *Server) Close() error

Close shuts down the server.

func (*Server) DRPC

func (p *Server) DRPC() *drpcmux.Mux

DRPC returns the server's dRPC mux for registration purposes.

func (*Server) Identity

func (p *Server) Identity() *identity.FullIdentity

Identity returns the server's identity.

func (*Server) PrivateAddr

func (p *Server) PrivateAddr() net.Addr

PrivateAddr returns the server's private listener address.

func (*Server) PrivateDRPC

func (p *Server) PrivateDRPC() *drpcmux.Mux

PrivateDRPC returns the server's dRPC mux for registration purposes.

func (*Server) Run

func (p *Server) Run(ctx context.Context) (err error)

Run will run the server and all of its services.