server

Documentation

Overview

Package server implements the entry point for running a robot web server.

Index

• func RunServer(ctx context.Context, args []string, logger golog.Logger) (err error)
• type Arguments

Functions

func RunServer

func RunServer(ctx context.Context, args []string, logger golog.Logger) (err error)

RunServer is an entry point to starting the web server that can be called by main in a code sample or otherwise be used to initialize the server.

Types

type Arguments

type Arguments struct {
	AllowInsecureCreds bool   `flag:"allow-insecure-creds,usage=allow connections to send credentials over plaintext"`
	ConfigFile         string `flag:"0,required,usage=robot config file"`
	CPUProfile         string `flag:"cpuprofile,usage=write cpu profile to file"`
	Debug              bool   `flag:"debug"`
	LogURL             string `flag:"logurl,usage=url to log messages to"`
	SharedDir          string `flag:"shareddir,usage=web resource directory"`
	Version            bool   `flag:"version,usage=print version"`
	WebProfile         bool   `flag:"webprofile,usage=include profiler in http server"`
	WebRTC             bool   `flag:"webrtc,usage=force webrtc connections instead of direct"`
}

Arguments for the command.