service

Documentation

Index

• type Close
• type Command
• type Flags
• type HandlerFunc
• type Init
• type Middleware
• type Options
• type Request
• type RequestHeader
• type Response
• type ResponseHeader
• type Router
• type Service
• type Web
• type WebApp
• type WebHandler

Types

type Close

type Close interface {
	Close()
}

type Command

type Command interface {
	Command() *cli.Command
	Start() error
	Stop() error
}

type Flags

type Flags interface {
	Flags() []cli.Flag
}

type HandlerFunc

type HandlerFunc func(ctx context.Context, req Request, resp Response) error

type Init

type Init interface {
	Init()
}

type Middleware

type Middleware func(next HandlerFunc) HandlerFunc

type Options

type Options struct {
	Id        string            `json:"id,omitempty"`
	Name      string            `json:"name,omitempty"`
	Version   string            `json:"version,omitempty"`
	Port      int               `json:"port,omitempty"`
	Addr      string            `json:"addr,omitempty"`
	Advertise string            `json:"advertise,omitempty"`
	Metadata  map[string]string `json:"metadata,omitempty"`
}

type Request

type Request interface {
	// Client server or client
	Client() bool

	// Kind [http|grpc...]
	Kind() string

	// Stream Indicates whether it's a stream
	Stream() bool

	// Service name requested
	Service() string

	// Operation requested
	Operation() string

	// Endpoint requested
	Endpoint() string

	// ContentType Content type provided
	ContentType() string

	// Header of the request
	Header() *RequestHeader

	// Payload is the decoded value
	Payload() interface{}
}

Request is a synchronous request interface

type RequestHeader

type RequestHeader = fasthttp.RequestHeader

type Response

type Response interface {
	Header() *ResponseHeader
	Payload() interface{}
	Stream() bool
}

Response is the response writer for un encoded messages

type ResponseHeader

type ResponseHeader = fasthttp.ResponseHeader

type Router

type Router func(app *fiber.App)

type Service

type Service interface {
	grpc.ServiceRegistrar
	Command
	Options() Options
	Provider(provider interface{})
	SubCmd(cmd *cli.Command)
}

type Web

type Web interface {
	Command
	Options() Options
	Provider(provider interface{})
	SubCmd(cmd *cli.Command)
}

type WebApp

type WebApp struct {
	*fiber.App
}

type WebHandler

type WebHandler interface {
	Router(r fiber.Router)
}