mux

Documentation

Overview

Package mux contains abstractions for http multiplexing of APIs.

Index

• type PathRecorderMux
  • func NewPathRecorderMux(name string) *PathRecorderMux
  • func (m *PathRecorderMux) Handle(path string, handler http.Handler)
  • func (m *PathRecorderMux) HandleFunc(path string, handler func(http.ResponseWriter, *http.Request))
  • func (m *PathRecorderMux) HandlePrefix(path string, handler http.Handler)
  • func (m *PathRecorderMux) ListedPaths() []string
  • func (m *PathRecorderMux) NotFoundHandler(notFoundHandler http.Handler)
  • func (m *PathRecorderMux) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (m *PathRecorderMux) UnlistedHandle(path string, handler http.Handler)
  • func (m *PathRecorderMux) UnlistedHandleFunc(path string, handler func(http.ResponseWriter, *http.Request))
  • func (m *PathRecorderMux) UnlistedHandlePrefix(path string, handler http.Handler)
  • func (m *PathRecorderMux) Unregister(path string)

Types

type PathRecorderMux

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

PathRecorderMux wraps a mux object and records the registered exposedPaths.

func NewPathRecorderMux

func NewPathRecorderMux(name string) *PathRecorderMux

NewPathRecorderMux creates a new PathRecorderMux

func (*PathRecorderMux) Handle

func (m *PathRecorderMux) Handle(path string, handler http.Handler)

Handle registers the handler for the given pattern. If a handler already exists for pattern, Handle panics.

func (*PathRecorderMux) HandleFunc

func (m *PathRecorderMux) HandleFunc(path string, handler func(http.ResponseWriter, *http.Request))

HandleFunc registers the handler function for the given pattern. If a handler already exists for pattern, Handle panics.

func (*PathRecorderMux) HandlePrefix

func (m *PathRecorderMux) HandlePrefix(path string, handler http.Handler)

HandlePrefix is like Handle, but matches for anything under the path. Like a standard golang trailing slash.

func (*PathRecorderMux) ListedPaths

func (m *PathRecorderMux) ListedPaths() []string

ListedPaths returns the registered handler exposedPaths.

func (*PathRecorderMux) NotFoundHandler

func (m *PathRecorderMux) NotFoundHandler(notFoundHandler http.Handler)

NotFoundHandler sets the handler to use if there's no match for a give path

func (*PathRecorderMux) ServeHTTP

func (m *PathRecorderMux) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP makes it an http.Handler

func (*PathRecorderMux) UnlistedHandle

func (m *PathRecorderMux) UnlistedHandle(path string, handler http.Handler)

UnlistedHandle registers the handler for the given pattern, but doesn't list it. If a handler already exists for pattern, Handle panics.

func (*PathRecorderMux) UnlistedHandleFunc

func (m *PathRecorderMux) UnlistedHandleFunc(path string, handler func(http.ResponseWriter, *http.Request))

UnlistedHandleFunc registers the handler function for the given pattern, but doesn't list it. If a handler already exists for pattern, Handle panics.

func (*PathRecorderMux) UnlistedHandlePrefix

func (m *PathRecorderMux) UnlistedHandlePrefix(path string, handler http.Handler)

UnlistedHandlePrefix is like UnlistedHandle, but matches for anything under the path. Like a standard golang trailing slash.

func (*PathRecorderMux) Unregister

func (m *PathRecorderMux) Unregister(path string)

Unregister removes a path from the mux.