api

Documentation

Index

• Constants
• type API
  • func NewAPI(cfg Config) (*API, error)
  • func (s *API) Shutdown(ctx context.Context) error
  • func (s *API) Start() error
• type Config
• type Context
  • func (c *Context) Bind(i any) error
  • func (c *Context) Done() <-chan any
  • func (c *Context) Error(code int, err error)
  • func (c *Context) JSON(code int, data any) error
  • func (c *Context) Request() *http.Request
  • func (c *Context) String(code int, s string) error
  • func (c *Context) SubmitJob(ij *input.Job, listeners ...request.JobListener) (*tork.Job, error)

Constants

const (
	MIN_PORT = 8000
	MAX_PORT = 8100
)

Types

type API

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

func NewAPI

func NewAPI(cfg Config) (*API, error)

func (*API) Shutdown

func (s *API) Shutdown(ctx context.Context) error

func (*API) Start

func (s *API) Start() error

type Config

type Config struct {
	Broker      mq.Broker
	DataStore   datastore.Datastore
	Address     string
	Middlewares []request.MiddlewareFunc
	Endpoints   map[string]request.HandlerFunc
	Enabled     map[string]bool
}

type Context

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

func (*Context) Bind

func (c *Context) Bind(i any) error

func (*Context) Done

func (c *Context) Done() <-chan any

func (*Context) Error

func (c *Context) Error(code int, err error)

func (*Context) JSON

func (c *Context) JSON(code int, data any) error

func (*Context) Request

func (c *Context) Request() *http.Request

func (*Context) String

func (c *Context) String(code int, s string) error

func (*Context) SubmitJob

func (c *Context) SubmitJob(ij *input.Job, listeners ...request.JobListener) (*tork.Job, error)