xtermservice

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/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/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 TemplateVariables
• type XtermService
• type XtermServiceImpl
  • func (xtermService *XtermServiceImpl) Handler(ctx context.Context) *http.ServeMux

Examples

• XtermServiceImpl.Handler

Types

type TemplateVariables

type TemplateVariables struct {
	HtmlTitle      string
	UrlRoutePrefix string
}

type XtermService

type XtermService interface {
	Handler(ctx context.Context) *http.ServeMux
}

The XtermService interface...

type XtermServiceImpl

type XtermServiceImpl struct {
	AllowedHostnames     []string
	Arguments            []string
	Command              string
	ConnectionErrorLimit int
	HtmlTitle            string
	KeepalivePingTimeout int
	MaxBufferSizeBytes   int
	UrlRoutePrefix       string
}

XtermServiceImpl is the default implementation of the HttpServer interface.

func (*XtermServiceImpl) Handler

func (xtermService *XtermServiceImpl) Handler(ctx context.Context) *http.ServeMux

func (xtermService *XtermServiceImpl) Handler(ctx context.Context) error {

Example