handler

Documentation

Index

• Constants
• func BuildErrorWithJSON(msg string, logger boshlog.Logger) ([]byte, error)
• type CommonEventFormat
  • func NewCommonEventFormat() CommonEventFormat
• type Func
• type Handler
• type ProtocolVersion
• type Request
  • func NewRequest(replyTo, method string, payload []byte, protocolVersion ProtocolVersion) Request
  • func PerformHandlerWithJSON(rawJSON []byte, handler Func, maxResponseLength int, logger boshlog.Logger) ([]byte, Request, error)
  • func (r Request) GetPayload() []byte
• type Response
  • func NewExceptionResponse(err error) (resp Response)
  • func NewValueResponse(value interface{}) Response
• type Target
• type Topic

Constants

const (
	Director      = Target("director")
	HealthMonitor = Target("hm")
)

const (
	Heartbeat = Topic("heartbeat")
	Alert     = Topic("alert")
	Shutdown  = Topic("shutdown")
)

const (
	UnlimitedResponseLength = -1
)

Functions

func BuildErrorWithJSON

func BuildErrorWithJSON(msg string, logger boshlog.Logger) ([]byte, error)

Types

type CommonEventFormat

type CommonEventFormat interface {
	ProduceHTTPRequestEventLog(*http.Request, int, string) (string, error)
	ProduceNATSRequestEventLog(string, string, string, string, int, string, string) (string, error)
}

func NewCommonEventFormat

func NewCommonEventFormat() CommonEventFormat

type Func

type Func func(req Request) (resp Response)

type Handler

type Handler interface {
	Run(handlerFunc Func) error
	Start(handlerFunc Func) error
	Stop()

	RegisterAdditionalFunc(handlerFunc Func)

	Send(target Target, topic Topic, message interface{}) error
}

type ProtocolVersion

type ProtocolVersion int

type Request

type Request struct {
	ReplyTo         string `json:"reply_to"`
	Method          string
	Payload         []byte
	ProtocolVersion ProtocolVersion `json:"protocol"`
}

func NewRequest

func NewRequest(replyTo, method string, payload []byte, protocolVersion ProtocolVersion) Request

func PerformHandlerWithJSON

func PerformHandlerWithJSON(rawJSON []byte, handler Func, maxResponseLength int, logger boshlog.Logger) ([]byte, Request, error)

func (Request) GetPayload

func (r Request) GetPayload() []byte

type Response

type Response interface {
	// Shorten attempts to return a response
	// that can be serialized in a smaller size.
	Shorten() Response
}

func NewExceptionResponse

func NewExceptionResponse(err error) (resp Response)

func NewValueResponse

func NewValueResponse(value interface{}) Response

type Target

type Target string

type Topic

type Topic string