api

Documentation

Index

• Variables
• type Server
  • func NewServer(proto, addr string) (*Server, error)
  • func (s *Server) Close() error
  • func (s *Server) Middleware(h httprouter.Handle) httprouter.Handle
  • func (s *Server) Serve() error
  • func (s *Server) ServeRequest(w http.ResponseWriter, req *http.Request)

Variables

var WebsocketUpgrader = websocket.Upgrader{
	EnableCompression: true,

	WriteBufferSize: 128,
}

WebsocketUpgrader represents the default websocket.Upgrader that prow employs

Types

type Server

type Server struct {
	HTTPServer   *http.Server
	Listener     net.Listener
	DockerClient *docker.Client
	HelmClient   *helm.Client
	// RegistryAuth is the authorization token used to push images up to the registry.
	//
	// This field follows the format of the X-Registry-Auth header.
	RegistryAuth string
	// RegistryOrg is the organization (e.g. your DockerHub account) used to push images
	// up to the registry.
	RegistryOrg string
	// RegistryURL is the URL of the registry (e.g. quay.io, docker.io, gcr.io)
	RegistryURL string
}

Server is an API Server which listens and responds to HTTP requests.

func NewServer

func NewServer(proto, addr string) (*Server, error)

NewServer sets up the required Server and does protocol specific checking.

func (*Server) Close

func (s *Server) Close() error

Close shuts down the HTTP server, dropping all current connections.

func (*Server) Middleware

func (s *Server) Middleware(h httprouter.Handle) httprouter.Handle

Middleware adds additional context before handling requests

func (*Server) Serve

func (s *Server) Serve() error

Serve starts the HTTP server, accepting all new connections.

func (*Server) ServeRequest

func (s *Server) ServeRequest(w http.ResponseWriter, req *http.Request)

ServeRequest processes a single HTTP request.