sdk

Documentation

Index

• Constants
• func DecodeRequest(w http.ResponseWriter, r *http.Request, req interface{}) (err error)
• func EncodeResponse(w http.ResponseWriter, res interface{}, err string)
• func StreamResponse(w http.ResponseWriter, data io.ReadCloser)
• type Handler
  • func NewHandler(manifest string) Handler
  • func (h Handler) HandleFunc(path string, fn func(w http.ResponseWriter, r *http.Request))
  • func (h Handler) Serve(l net.Listener) error
  • func (h Handler) ServeTCP(pluginName, addr string, tlsConfig *tls.Config) error
  • func (h Handler) ServeUnix(addr string, gid int) error

Constants

const DefaultContentTypeV1_1 = "application/vnd.docker.plugins.v1.1+json"

DefaultContentTypeV1_1 is the default content type accepted and sent by the plugins.

Functions

func DecodeRequest

func DecodeRequest(w http.ResponseWriter, r *http.Request, req interface{}) (err error)

DecodeRequest decodes an http request into a given structure.

func EncodeResponse

func EncodeResponse(w http.ResponseWriter, res interface{}, err string)

EncodeResponse encodes the given structure into an http response.

func StreamResponse

func StreamResponse(w http.ResponseWriter, data io.ReadCloser)

StreamResponse streams a response object to the client

Types

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

Handler is the base to create plugin handlers. It initializes connections and sockets to listen to.

func NewHandler

func NewHandler(manifest string) Handler

NewHandler creates a new Handler with an http mux.

func (Handler) HandleFunc

func (h Handler) HandleFunc(path string, fn func(w http.ResponseWriter, r *http.Request))

HandleFunc registers a function to handle a request path with.

func (Handler) Serve

func (h Handler) Serve(l net.Listener) error

Serve sets up the handler to serve requests on the passed in listener

func (Handler) ServeTCP

func (h Handler) ServeTCP(pluginName, addr string, tlsConfig *tls.Config) error

ServeTCP makes the handler to listen for request in a given TCP address. It also writes the spec file on the right directory for docker to read.

func (Handler) ServeUnix

func (h Handler) ServeUnix(addr string, gid int) error

ServeUnix makes the handler to listen for requests in a unix socket. It also creates the socket file on the right directory for docker to read.