httpserver

package

v0.2.1 Latest Latest Go to latest Published: Jan 30, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/senzing-garage/serve-http

Links

Open Source Insights

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 ¶

type HttpServer
type HttpServerImpl
- func (httpServer *HttpServerImpl) Serve(ctx context.Context) error
type TemplateVariables

Examples ¶

HttpServerImpl.Serve

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type HttpServer ¶

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

The HttpServer interface...

type HttpServerImpl ¶

type HttpServerImpl struct {
	ApiUrlRoutePrefix              string // FIXME: Only works with "api"
	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
	SenzingEngineConfigurationJson string
	SenzingModuleName              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"
}

HttpServerImpl is the default implementation of the HttpServer interface.

func (*HttpServerImpl) Serve ¶

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

Example ¶

Output:

type TemplateVariables ¶

type TemplateVariables struct {
	HttpServerImpl
	ApiServerStatus string
	ApiServerUrl    string
	HtmlTitle       string
	RequestHost     string
	SwaggerStatus   string
	SwaggerUrl      string
	XtermStatus     string
	XtermUrl        string
}

Source Files ¶

View all Source files

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