rcserver

Documentation

Overview

Package rcserver implements the HTTP endpoint to serve the remote control

Package rcserver implements the HTTP endpoint to serve the remote control

Index

• type MetricsServer
  • func MetricsStart(ctx context.Context, opt *rc.Options) (*MetricsServer, error)
  • func (s *MetricsServer) Serve() error
  • func (s *MetricsServer) Shutdown() error
  • func (s *MetricsServer) Wait()
• type Server
  • func Start(ctx context.Context, opt *rc.Options) (*Server, error)
  • func (s *Server) Serve() error
  • func (s *Server) Shutdown() error
  • func (s *Server) Wait()

Types

type MetricsServer

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

MetricsServer contains everything to run the rc server

func MetricsStart

func MetricsStart(ctx context.Context, opt *rc.Options) (*MetricsServer, error)

MetricsStart the remote control server if configured

If the server wasn't configured the *Server returned may be nil

func (*MetricsServer) Serve

func (s *MetricsServer) Serve() error

Serve runs the http server in the background.

Use s.Close() and s.Wait() to shutdown server

func (*MetricsServer) Shutdown

func (s *MetricsServer) Shutdown() error

Shutdown gracefully shuts down the server

func (*MetricsServer) Wait

func (s *MetricsServer) Wait()

Wait blocks while the server is serving requests

type Server

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

Server contains everything to run the rc server

func Start

func Start(ctx context.Context, opt *rc.Options) (*Server, error)

Start the remote control server if configured

If the server wasn't configured the *Server returned may be nil

func (*Server) Serve

func (s *Server) Serve() error

Serve runs the http server in the background.

Use s.Close() and s.Wait() to shutdown server

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown gracefully shuts down the server

func (*Server) Wait

func (s *Server) Wait()

Wait blocks while the server is serving requests