http_api

Documentation

Index

• Variables
• func CompressHandler(h http.Handler) http.Handler
• func Decorate(f APIHandler, ds ...Decorator) httprouter.Handle
• func GetTopicArg(rp getter) (string, error)
• func GetTopicChannelArgs(rp getter) (string, string, error)
• func GetTopicPartitionArgs(rp getter) (string, int, error)
• func GetTopicPartitionChannelArgs(rp getter) (string, int, string, error)
• func LogMethodNotAllowedHandler(l *levellogger.LevelLogger) http.Handler
• func LogNotFoundHandler(l *levellogger.LevelLogger) http.Handler
• func LogPanicHandler(l *levellogger.LevelLogger) func(w http.ResponseWriter, req *http.Request, p interface{})
• func NewDeadlineTransport(timeout time.Duration) *http.Transport
• func Respond(w http.ResponseWriter, statusCode int, statusTxt string, data interface{})
• func RespondV1(w http.ResponseWriter, code int, data interface{})
• func Serve(listener net.Listener, handler http.Handler, proto string, ...)
• type APIHandler
  • func DeprecatedAPI(f APIHandler) APIHandler
  • func NegotiateVersion(f APIHandler) APIHandler
  • func PlainText(f APIHandler) APIHandler
  • func V1(f APIHandler) APIHandler
• type Client
  • func NewClient(tlsConfig *tls.Config) *Client
  • func (c *Client) GETV1(endpoint string, v interface{}) (int, error)
  • func (c *Client) NegotiateV1(endpoint string, v interface{}) error
  • func (c *Client) POSTV1(endpoint string) (int, error)
• type Decorator
  • func DebugLog(l *levellogger.LevelLogger) Decorator
  • func Log(l *levellogger.LevelLogger) Decorator
• type Err
  • func (e Err) Error() string
• type PostParams
  • func (p *PostParams) Get(key string) (string, error)
• type ReqParams
  • func NewReqParams(req *http.Request) (*ReqParams, error)
  • func (r *ReqParams) Get(key string) (string, error)
  • func (r *ReqParams) GetAll(key string) ([]string, error)

Variables

var (
	ErrDeprecatedAPI = errors.New("deprecated api")
)

Functions

func CompressHandler

func CompressHandler(h http.Handler) http.Handler

CompressHandler gzip compresses HTTP responses for clients that support it via the 'Accept-Encoding' header.

func Decorate

func Decorate(f APIHandler, ds ...Decorator) httprouter.Handle

func GetTopicArg

func GetTopicArg(rp getter) (string, error)

func GetTopicChannelArgs

func GetTopicChannelArgs(rp getter) (string, string, error)

func GetTopicPartitionArgs

func GetTopicPartitionArgs(rp getter) (string, int, error)

partition can be missing, default as 0.

func GetTopicPartitionChannelArgs

func GetTopicPartitionChannelArgs(rp getter) (string, int, string, error)

func LogMethodNotAllowedHandler

func LogMethodNotAllowedHandler(l *levellogger.LevelLogger) http.Handler

func LogNotFoundHandler

func LogNotFoundHandler(l *levellogger.LevelLogger) http.Handler

func LogPanicHandler

func LogPanicHandler(l *levellogger.LevelLogger) func(w http.ResponseWriter, req *http.Request, p interface{})

func NewDeadlineTransport

func NewDeadlineTransport(timeout time.Duration) *http.Transport

A custom http.Transport with support for deadline timeouts

func Respond

func Respond(w http.ResponseWriter, statusCode int, statusTxt string, data interface{})

func RespondV1

func RespondV1(w http.ResponseWriter, code int, data interface{})

func Serve

func Serve(listener net.Listener, handler http.Handler, proto string, l levellogger.Logger)

Types

type APIHandler

type APIHandler func(http.ResponseWriter, *http.Request, httprouter.Params) (interface{}, error)

func DeprecatedAPI

func DeprecatedAPI(f APIHandler) APIHandler

func NegotiateVersion

func NegotiateVersion(f APIHandler) APIHandler

func PlainText

func PlainText(f APIHandler) APIHandler

func V1

func V1(f APIHandler) APIHandler

type Client

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

func NewClient

func NewClient(tlsConfig *tls.Config) *Client

func (*Client) GETV1

func (c *Client) GETV1(endpoint string, v interface{}) (int, error)

GETV1 is a helper function to perform a V1 HTTP request and parse our NSQ daemon's expected response format, with deadlines.

func (*Client) NegotiateV1

func (c *Client) NegotiateV1(endpoint string, v interface{}) error

NegotiateV1 is a helper function to perform a v1 HTTP request and fallback to parsing the old backwards-compatible response format storing the result in the value pointed to by v.

TODO: deprecated, remove in 1.0 (replace calls with GETV1)

func (*Client) POSTV1

func (c *Client) POSTV1(endpoint string) (int, error)

PostV1 is a helper function to perform a V1 HTTP request and parse our NSQ daemon's expected response format, with deadlines.

type Decorator

type Decorator func(APIHandler) APIHandler

func DebugLog

func DebugLog(l *levellogger.LevelLogger) Decorator

func Log

func Log(l *levellogger.LevelLogger) Decorator

type Err

type Err struct {
	Code int
	Text string
}

func (Err) Error

func (e Err) Error() string

type PostParams

type PostParams struct {
	*http.Request
}

func (*PostParams) Get

func (p *PostParams) Get(key string) (string, error)

type ReqParams

type ReqParams struct {
	url.Values
	Body []byte
}

func NewReqParams

func NewReqParams(req *http.Request) (*ReqParams, error)

func (*ReqParams) Get

func (r *ReqParams) Get(key string) (string, error)

func (*ReqParams) GetAll

func (r *ReqParams) GetAll(key string) ([]string, error)