httpserver

package
v0.2.2 Latest Latest
Warning

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

Go to latest
Published: Jul 3, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

One or two sentence synopsis of the package...

Overview

One or two paragraph overview of the package... (This page describes the nature of the individual package.)

More information at https://github.com/senzing-garage/serve-http

Another Header

Details of the package... Lorem ipsum dolor sit amet, consectetur adipiscing elit...

Examples

The examples given here should be specific to the package.

Examples of use can be seen in the examplepackage_test.go files.

package main
import (
	fmt

	"github.com/senzing-garage/serve-http/examplepackage"
)

func main() {
	ctx := context.TODO()
	testObject := &ExamplePackageImpl{
		Something: "I'm here",
	}
	err := testObject.SaySomething(ctx)
	if err != nil {
		fmt.Println("whoops")
	}
}

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BasicHTTPServer added in v0.2.2

type BasicHTTPServer struct {
	APIUrlRoutePrefix         string // FIXME: Only works with "api"
	AvoidServing              bool
	EnableAll                 bool
	EnableSenzingRestAPI      bool
	EnableSwaggerUI           bool
	EnableXterm               bool
	GrpcDialOptions           []grpc.DialOption
	GrpcTarget                string
	LogLevelName              string
	ObserverOrigin            string
	Observers                 []observer.Observer
	OpenAPISpecificationRest  []byte
	ReadHeaderTimeout         time.Duration
	SenzingSettings           string
	SenzingInstanceName       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 added in v0.2.2

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

type HTTPServer added in v0.2.2

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

The HTTPServer interface...

type TemplateVariables

type TemplateVariables struct {
	BasicHTTPServer
	APIServerStatus string
	APIServerURL    string
	HTMLTitle       string
	RequestHost     string
	SwaggerStatus   string
	SwaggerURL      string
	XtermStatus     string
	XtermURL        string
}

Jump to

Keyboard shortcuts

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