httpserver

Documentation

Overview

Package httpserver serves up HTTP requests.

Index

• type BasicHTTPServer
  • func (httpServer *BasicHTTPServer) Serve(ctx context.Context) error
• type HTTPServer
• type TemplateVariables

Examples

• BasicHTTPServer.Serve

Types

type BasicHTTPServer

type BasicHTTPServer struct {
	APIUrlRoutePrefix         string // FIXME: Only works with "api"
	AvoidServing              bool
	EnableAll                 bool
	EnableEntitySearch        bool
	EnableJupyterLab          bool
	EnableSenzingRestAPI      bool
	EnableSwaggerUI           bool
	EnableXterm               bool
	EntitySearchRoutePrefix   string // FIXME: Only works with "entity-search"
	GrpcDialOptions           []grpc.DialOption
	GrpcTarget                string
	IsInDevelopment           bool
	JupyterLabRoutePrefix     string // FIXME: Only works with "jupyter"
	LogLevelName              string
	ObserverOrigin            string
	Observers                 []observer.Observer
	OpenAPISpecificationRest  []byte
	ReadHeaderTimeout         time.Duration
	SenzingInstanceName       string
	SenzingSettings           string
	SenzingVerboseLogging     int64
	ServerAddress             string
	ServerOptions             []senzingrestapi.ServerOption
	ServerPort                int
	SwaggerURLRoutePrefix     string // FIXME: Only works with "swagger"
	TtyOnly                   bool
	XtermAllowedHostnames     []string
	XtermArguments            []string
	XtermCommand              string
	XtermConnectionErrorLimit int
	XtermKeepalivePingTimeout int
	XtermMaxBufferSizeBytes   int
	XtermURLRoutePrefix       string // FIXME: Only works with "xterm"
}

BasicHTTPServer is the default implementation of the HttpServer interface.

func (*BasicHTTPServer) Serve

func (httpServer *BasicHTTPServer) Serve(ctx context.Context) error

Example

type HTTPServer

type HTTPServer interface {
	Serve(ctx context.Context) error
}

The HTTPServer interface...

type TemplateVariables

type TemplateVariables struct {
	APIServerStatus string
	APIServerURL    string
	BasicHTTPServer
	EntitySearchStatus string
	EntitySearchURL    string
	HTMLTitle          string
	JupyterLabStatus   string
	JupyterLabURL      string
	RequestHost        string
	SwaggerStatus      string
	SwaggerURL         string
	XtermStatus        string
	XtermURL           string
}