faas

Documentation

Index

• Variables
• func NewWorkPool(maxWorkers int) *workPool
• type ApiWorkerOptions
• type DataRequest
• type EventContext
• type EventHandler
• type EventMiddleware
  • func ComposeEventMiddleware(funcs ...EventMiddleware) EventMiddleware
• type EventRequest
• type EventResponse
• type Frequency
• type HandlerBuilder
  • func New() HandlerBuilder
• type HandlerProvider
• type HttpContext
• type HttpHandler
• type HttpMiddleware
  • func ComposeHttpMiddlware(funcs ...HttpMiddleware) HttpMiddleware
• type HttpRequest
• type HttpResponse
• type RateWorkerOptions
• type SubscriptionWorkerOptions
• type TriggerContext
• type TriggerHandler
• type TriggerMiddleware
  • func ComposeTriggerMiddleware(funcs ...TriggerMiddleware) TriggerMiddleware

Variables

var Frequencies = []Frequency{"days", "hours", "minutes"}

Functions

func NewWorkPool

func NewWorkPool(maxWorkers int) *workPool

Types

type ApiWorkerOptions

type ApiWorkerOptions struct {
	ApiName          string
	Path             string
	Security         map[string][]string
	SecurityDisabled bool
}

type DataRequest

type DataRequest interface {
	Data() []byte
	MimeType() string
	Context() context.Context
}

type EventContext

type EventContext struct {
	Request  EventRequest
	Response *EventResponse
	Extras   map[string]interface{}
}

type EventHandler

type EventHandler = func(*EventContext) (*EventContext, error)

type EventMiddleware

type EventMiddleware = func(*EventContext, EventHandler) (*EventContext, error)

func ComposeEventMiddleware

func ComposeEventMiddleware(funcs ...EventMiddleware) EventMiddleware

ComposeEventMiddleware - Composes an array of middleware into a single middleware

type EventRequest

type EventRequest interface {
	DataRequest
	Topic() string
}

type EventResponse

type EventResponse struct {
	Success bool
}

type Frequency

type Frequency string //= "days" | "hours" | "minutes";

type HandlerBuilder

type HandlerBuilder interface {
	Http(string, ...HttpMiddleware) HandlerBuilder
	Event(...EventMiddleware) HandlerBuilder
	Default(...TriggerMiddleware) HandlerBuilder
	WithApiWorkerOpts(ApiWorkerOptions) HandlerBuilder
	WithRateWorkerOpts(RateWorkerOptions) HandlerBuilder
	WithSubscriptionWorkerOpts(SubscriptionWorkerOptions) HandlerBuilder
	Start() error
	String() string
}

func New

func New() HandlerBuilder

Creates a new HandlerBuilder

type HandlerProvider

type HandlerProvider interface {
	GetHttp(method string) HttpMiddleware
	GetEvent() EventMiddleware
	GetDefault() TriggerMiddleware
}

type HttpContext

type HttpContext struct {
	Request  HttpRequest
	Response *HttpResponse
	Extras   map[string]interface{}
}

type HttpHandler

type HttpHandler = func(*HttpContext) (*HttpContext, error)

type HttpMiddleware

type HttpMiddleware = func(*HttpContext, HttpHandler) (*HttpContext, error)

func ComposeHttpMiddlware

func ComposeHttpMiddlware(funcs ...HttpMiddleware) HttpMiddleware

ComposeHttpMiddleware - Composes an array of middleware into a single middleware

type HttpRequest

type HttpRequest interface {
	DataRequest
	Context() context.Context
	Method() string
	Path() string
	Query() map[string][]string
	Headers() map[string][]string
	PathParams() map[string]string
}

type HttpResponse

type HttpResponse struct {
	Status  int
	Headers map[string][]string
	Body    []byte
}

type RateWorkerOptions

type RateWorkerOptions struct {
	Description string
	Rate        int
	Frequency   Frequency
}

type SubscriptionWorkerOptions

type SubscriptionWorkerOptions struct {
	Topic string
}

type TriggerContext

type TriggerContext interface {
	Http() *HttpContext
	Event() *EventContext
}

type TriggerHandler

type TriggerHandler = func(TriggerContext) (TriggerContext, error)

type TriggerMiddleware

type TriggerMiddleware = func(TriggerContext, TriggerHandler) (TriggerContext, error)

func ComposeTriggerMiddleware

func ComposeTriggerMiddleware(funcs ...TriggerMiddleware) TriggerMiddleware

CreateTriggerMiddleware - Chains Trigger middleware functions together to single handler