util

Documentation

Index

• Constants
• func ApiRequest(endpoint string) (*simplejson.Json, error)
• func ApiResponse(w http.ResponseWriter, statusCode int, statusTxt string, data interface{})
• func ByteToBase10(b []byte) (n uint64, err error)
• func Commafy(i interface{}) string
• func GetTopicChannelArgs(rp Getter) (string, string, error)
• func HTTPServer(listener net.Listener, handler http.Handler)
• func NewDeadlineTransport(timeout time.Duration) *http.Transport
• func SendFramedResponse(w io.Writer, frameType int32, data []byte) (int, error)
• func SendResponse(w io.Writer, data []byte) (int, error)
• func StatsdHostKey(h string) string
• func StringAdd(s []string, a string) []string
• func StringUnion(s []string, a []string) []string
• func TCPServer(listener net.Listener, handler TCPHandler)
• func Version(app string) string
• type ChildErr
• type ClientErr
  • func NewClientErr(parent error, code string, description string) *ClientErr
  • func (e *ClientErr) Error() string
  • func (e *ClientErr) Parent() error
• type FatalClientErr
  • func NewFatalClientErr(parent error, code string, description string) *FatalClientErr
  • func (e *FatalClientErr) Error() string
  • func (e *FatalClientErr) Parent() error
• type Getter
• type PostParams
  • func (p *PostParams) Get(key string) (string, error)
• type Protocol
• 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)
• type StatsdClient
  • func NewStatsdClient(addr string, prefix string) *StatsdClient
  • func (c *StatsdClient) Close() error
  • func (c *StatsdClient) CreateSocket() error
  • func (c *StatsdClient) Decr(stat string, count int64) error
  • func (c *StatsdClient) Gauge(stat string, value int64) error
  • func (c *StatsdClient) Incr(stat string, count int64) error
  • func (c *StatsdClient) String() string
  • func (c *StatsdClient) Timing(stat string, delta int64) error
• type StringArray
  • func (a *StringArray) Set(s string) error
  • func (a *StringArray) String() string
• type TCPHandler
• type WaitGroupWrapper
  • func (w *WaitGroupWrapper) Wrap(cb func())

Constants

const BINARY_VERSION = "0.2.23"

Functions

func ApiRequest

func ApiRequest(endpoint string) (*simplejson.Json, error)

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

{"status_code":200, "status_txt":"OK", "data":{...}}

func ApiResponse

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

func ByteToBase10

func ByteToBase10(b []byte) (n uint64, err error)

func Commafy

func Commafy(i interface{}) string

func GetTopicChannelArgs

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

func HTTPServer

func HTTPServer(listener net.Listener, handler http.Handler)

func NewDeadlineTransport

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

A custom http.Transport with support for deadline timeouts

func SendFramedResponse

func SendFramedResponse(w io.Writer, frameType int32, data []byte) (int, error)

SendFramedResponse is a server side utility function to prefix data with a length header and frame header and write to the supplied Writer

func SendResponse

func SendResponse(w io.Writer, data []byte) (int, error)

SendResponse is a server side utility function to prefix data with a length header and write to the supplied Writer

func StatsdHostKey

func StatsdHostKey(h string) string

func StringAdd

func StringAdd(s []string, a string) []string

func StringUnion

func StringUnion(s []string, a []string) []string

func TCPServer

func TCPServer(listener net.Listener, handler TCPHandler)

func Version

func Version(app string) string

Types

type ChildErr

type ChildErr interface {
	Parent() error
}

type ClientErr

type ClientErr struct {
	ParentErr error
	Code      string
	Desc      string
}

ClientErr provides a way for NSQ daemons to log a human reabable error string and return a machine readable string to the client.

see docs/protocol.md for error codes by command

func NewClientErr

func NewClientErr(parent error, code string, description string) *ClientErr

NewClientErr creates a ClientErr with the supplied human and machine readable strings

func (*ClientErr) Error

func (e *ClientErr) Error() string

Error returns the machine readable form

func (*ClientErr) Parent

func (e *ClientErr) Parent() error

Parent returns the parent error

type FatalClientErr

type FatalClientErr struct {
	ParentErr error
	Code      string
	Desc      string
}

func NewFatalClientErr

func NewFatalClientErr(parent error, code string, description string) *FatalClientErr

NewClientErr creates a ClientErr with the supplied human and machine readable strings

func (*FatalClientErr) Error

func (e *FatalClientErr) Error() string

Error returns the machine readable form

func (*FatalClientErr) Parent

func (e *FatalClientErr) Parent() error

Parent returns the parent error

type Getter

type Getter interface {
	Get(key string) (string, error)
}

type PostParams

type PostParams struct {
	*http.Request
}

func (*PostParams) Get

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

type Protocol

type Protocol interface {
	IOLoop(conn net.Conn) error
}

Protocol describes the basic behavior of any protocol in the system

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)

type StatsdClient

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

func NewStatsdClient

func NewStatsdClient(addr string, prefix string) *StatsdClient

func (*StatsdClient) Close

func (c *StatsdClient) Close() error

func (*StatsdClient) CreateSocket

func (c *StatsdClient) CreateSocket() error

func (*StatsdClient) Decr

func (c *StatsdClient) Decr(stat string, count int64) error

func (*StatsdClient) Gauge

func (c *StatsdClient) Gauge(stat string, value int64) error

func (*StatsdClient) Incr

func (c *StatsdClient) Incr(stat string, count int64) error

func (*StatsdClient) String

func (c *StatsdClient) String() string

func (*StatsdClient) Timing

func (c *StatsdClient) Timing(stat string, delta int64) error

type StringArray

type StringArray []string

func (*StringArray) Set

func (a *StringArray) Set(s string) error

func (*StringArray) String

func (a *StringArray) String() string

type TCPHandler

type TCPHandler interface {
	Handle(net.Conn)
}

type WaitGroupWrapper

type WaitGroupWrapper struct {
	sync.WaitGroup
}

func (*WaitGroupWrapper) Wrap

func (w *WaitGroupWrapper) Wrap(cb func())