http

Documentation

Overview

HTTP transport for jobs.

Serve jobs over the http protocol, and provide a marshalling interface for the core geard jobs.

Index

• Variables
• func AddHttpExtension(extension HttpExtension)
• func NewHttpJobResponse(w http.ResponseWriter, skipStreaming bool, mode client.ResponseContentMode) jobs.Response
• type ExtensionMap
• type HeaderSerialization
• type HttpConfiguration
  • func (conf *HttpConfiguration) Handler() (http.Handler, error)
• type HttpContext
• type HttpExtension
• type JobHandler
• type StringHeader
  • func (s StringHeader) ToHeader() string
• type TabularOutput

Variables

var (
	ErrContentTypeDoesNotMatch = jobs.SimpleError{jobs.ResponseNotAcceptable, "The content type you requested is not available for this action."}
)

Functions

func AddHttpExtension

func AddHttpExtension(extension HttpExtension)

Register an extension to this server during init() or startup

func NewHttpJobResponse

func NewHttpJobResponse(w http.ResponseWriter, skipStreaming bool, mode client.ResponseContentMode) jobs.Response

Types

type ExtensionMap

type ExtensionMap map[client.RemoteJob]JobHandler

type HeaderSerialization

type HeaderSerialization interface {
	ToHeader() string
}

type HttpConfiguration

type HttpConfiguration struct {
	Docker     config.DockerConfiguration
	Dispatcher *dispatcher.Dispatcher
}

func (*HttpConfiguration) Handler

func (conf *HttpConfiguration) Handler() (http.Handler, error)

type HttpContext

type HttpContext struct {
	jobs.JobContext
	ApiVersion string
}

type HttpExtension

type HttpExtension interface {
	Routes() ExtensionMap
	HttpJobFor(request interface{}) (client.RemoteExecutable, error)
}

type JobHandler

type JobHandler func(*HttpConfiguration, *HttpContext, *rest.Request) (interface{}, error)

type StringHeader

type StringHeader string

func (StringHeader) ToHeader

func (s StringHeader) ToHeader() string

type TabularOutput

type TabularOutput interface {
	WriteTableTo(io.Writer) error
}