endpoint

Documentation

Overview

THIS FILE IS AUTO GENERATED BY GK-CLI DO NOT EDIT!!

Index

• func InstrumentingMiddleware(duration metrics.Histogram) endpoint.Middleware
• func LoggingMiddleware(logger log.Logger) endpoint.Middleware
• func MakeSendEndpoint(s service.NotificatorService) endpoint.Endpoint
• type Endpoints
  • func New(s service.NotificatorService, mdw map[string][]endpoint.Middleware) Endpoints
  • func (e Endpoints) Send(ctx context.Context, to string, body string) (id string, err error)
• type Failure
• type SendRequest
• type SendResponse
  • func (r SendResponse) Failed() error

Functions

func InstrumentingMiddleware

func InstrumentingMiddleware(duration metrics.Histogram) endpoint.Middleware

InstrumentingMiddleware returns an endpoint middleware that records the duration of each invocation to the passed histogram. The middleware adds a single field: "success", which is "true" if no error is returned, and "false" otherwise.

func LoggingMiddleware

func LoggingMiddleware(logger log.Logger) endpoint.Middleware

LoggingMiddleware returns an endpoint middleware that logs the duration of each invocation, and the resulting error, if any.

func MakeSendEndpoint

func MakeSendEndpoint(s service.NotificatorService) endpoint.Endpoint

MakeSendEndpoint returns an endpoint that invokes Send on the service.

Types

type Endpoints

type Endpoints struct {
	SendEndpoint endpoint.Endpoint
}

Endpoints collects all of the endpoints that compose a profile service. It's meant to be used as a helper struct, to collect all of the endpoints into a single parameter.

func New

func New(s service.NotificatorService, mdw map[string][]endpoint.Middleware) Endpoints

New returns a Endpoints struct that wraps the provided service, and wires in all of the expected endpoint middlewares

func (Endpoints) Send

func (e Endpoints) Send(ctx context.Context, to string, body string) (id string, err error)

Send implements Service. Primarily useful in a client.

type Failure

type Failure interface {
	Failed() error
}

Failure is an interface that should be implemented by response types. Response encoders can check if responses are Failer, and if so they've failed, and if so encode them using a separate write path based on the error.

type SendRequest

type SendRequest struct {
	To   string `json:"to"`
	Body string `json:"body"`
}

SendRequest collects the request parameters for the Send method.

type SendResponse

type SendResponse struct {
	Id  string `json:"id"`
	Err error  `json:"err"`
}

SendResponse collects the response parameters for the Send method.

func (SendResponse) Failed

func (r SendResponse) Failed() error

Failed implements Failer.