browseserver

Documentation

Overview

Package browseserver provides a web interface that can be used to interact with the vanadium debug interface.

Index

• func CreateServeMux(ctx *context.T, timeout time.Duration, log bool, assets fs.FS, ...) (*http.ServeMux, error)
• func Serve(ctx *context.T, httpAddr, name string, timeout time.Duration, assets fs.FS, ...) error
• type Tracer
  • func (t *Tracer) String() string

Functions

func CreateServeMux

func CreateServeMux(ctx *context.T, timeout time.Duration, log bool, assets fs.FS, urlPrefix string) (*http.ServeMux, error)

CreateServeMux returns a ServeMux object that has handlers set up.

func Serve

func Serve(ctx *context.T, httpAddr, name string, timeout time.Duration, assets fs.FS, log bool) error

Serve serves the debug interface over http. An HTTP server is started (serving at httpAddr), its various handlers make rpc calls to the given name to gather debug information. If log is true we additionally log debug information for these rpc requests. Timeout defines the timeout for the rpc calls. The HTTPServer will run until the passed context is canceled.

Types

type Tracer

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

Tracer forces collection of a trace rooted at the call to newTracer.

func (*Tracer) String

func (t *Tracer) String() string