rcserver

package
v0.0.0-...-b4aeae5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 7, 2024 License: MIT Imports: 31 Imported by: 0

Documentation

Overview

Package rcserver implements the HTTP endpoint to serve the remote control

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL