web

Documentation

Index

• Constants
• type Client
  • func (r *Client) Get(url string, out interface{}) (status int, err error)
  • func (r *Client) Post(url string, in interface{}, out interface{}) (status int, err error)
  • func (r *Client) Watch(url string, resource interface{}, handler EventHandler) (status int, w *Watch, err error)
• type Event
• type EventHandler
• type Paged
  • func (h *Paged) Prepare(ctx *gin.Context) int
• type Parity
  • func (c *Parity) EnsureParity(r container.Reconciler, w time.Duration) int
• type RequestHandler
• type ResourceBuilder
• type SchemaHandler
  • func (h *SchemaHandler) AddRoutes(r *gin.Engine)
  • func (h SchemaHandler) Get(ctx *gin.Context)
  • func (h *SchemaHandler) List(ctx *gin.Context)
• type StockEventHandler
  • func (r *StockEventHandler) Created(Event)
  • func (r *StockEventHandler) Deleted(Event)
  • func (r *StockEventHandler) End()
  • func (r *StockEventHandler) Error(*Watch, error)
  • func (r *StockEventHandler) Parity()
  • func (r *StockEventHandler) Started()
  • func (r *StockEventHandler) Updated(Event)
• type Watch
  • func (r *Watch) Alive() bool
  • func (r *Watch) End()
  • func (r *Watch) Repair() (err error)
• type WatchReader
  • func (r *WatchReader) Repair() (status int, err error)
  • func (r *WatchReader) Terminate()
• type WatchWriter
  • func (r *WatchWriter) Created(event model.Event)
  • func (r *WatchWriter) Deleted(event model.Event)
  • func (r *WatchWriter) End()
  • func (r *WatchWriter) Error(err error)
  • func (r *WatchWriter) Parity()
  • func (r *WatchWriter) Started()
  • func (r *WatchWriter) Updated(event model.Event)
• type Watched
  • func (h *Watched) Prepare(ctx *gin.Context) int
  • func (r *Watched) Watch(ctx *gin.Context, db model.DB, m model.Model, rb ResourceBuilder) (err error)
• type WebServer
  • func New(c *container.Container, routes ...RequestHandler) *WebServer
  • func (w *WebServer) Start()

Constants

const (
	WatchHeader = "X-Watch"
)

Header.

Types

type Client

type Client struct {
	// Transport.
	Transport http.RoundTripper
	// Headers.
	Header http.Header
}

REST client.

func (*Client) Get

func (r *Client) Get(url string, out interface{}) (status int, err error)

HTTP GET (method).

func (*Client) Post

func (r *Client) Post(url string, in interface{}, out interface{}) (status int, err error)

HTTP POST (method).

func (*Client) Watch

func (r *Client) Watch(
	url string,
	resource interface{},
	handler EventHandler) (status int, w *Watch, err error)

Watch a resource.

type Event

type Event struct {
	// Action.
	Action int8
	// Affected Resource.
	Resource interface{}
	// Updated resource.
	Updated interface{}
}

Event

type EventHandler

type EventHandler interface {
	// The watch has started.
	Started()
	// Parity marker.
	// The watch has delivered the initial set
	// of `Created` events.
	Parity()
	// Resource created.
	Created(r Event)
	// Resource updated.
	Updated(r Event)
	// Resource deleted.
	Deleted(r Event)
	// An error has occurred.
	// The handler may call the Repair() on
	// the watch to repair the watch as desired.
	Error(*Watch, error)
	// The watch has ended.
	End()
}

Event handler

type Paged

type Paged struct {
	// The `page` parameter passed in the request.
	Page model.Page
}

Paged handler.

func (*Paged) Prepare

func (h *Paged) Prepare(ctx *gin.Context) int

Prepare the handler to fulfil the request. Set the `page` field using passed parameters.

type Parity

type Parity struct {
}

Parity (not-partial) request handler.

func (*Parity) EnsureParity

func (c *Parity) EnsureParity(r container.Reconciler, w time.Duration) int

Ensure reconciler has achieved parity.

type RequestHandler

type RequestHandler interface {
	// Add routes to the `gin` router.
	AddRoutes(*gin.Engine)
	// List resources in a REST collection.
	List(*gin.Context)
	// Get a specific REST resource.
	Get(*gin.Context)
}

Web request handler.

type ResourceBuilder

type ResourceBuilder func(model.Model) interface{}

Watched resource builder.

type SchemaHandler

type SchemaHandler struct {

	// Schema version
	Version string
	// Schema release.
	Release int
	// contains filtered or unexported fields
}

Schema (route) handler.

func (*SchemaHandler) AddRoutes

func (h *SchemaHandler) AddRoutes(r *gin.Engine)

Add routes.

func (SchemaHandler) Get

func (h SchemaHandler) Get(ctx *gin.Context)

Not supported.

func (*SchemaHandler) List

func (h *SchemaHandler) List(ctx *gin.Context)

List schema.

type StockEventHandler

type StockEventHandler struct{}

Stock event handler. Provides default event methods.

func (*StockEventHandler) Created

func (r *StockEventHandler) Created(Event)

A model has been created.

func (*StockEventHandler) Deleted

func (r *StockEventHandler) Deleted(Event)

A model has been deleted.

func (*StockEventHandler) End

func (r *StockEventHandler) End()

An event watch has ended.

func (*StockEventHandler) Error

func (r *StockEventHandler) Error(*Watch, error)

An error has occurred reading events.

func (*StockEventHandler) Parity

func (r *StockEventHandler) Parity()

Watch has parity.

func (*StockEventHandler) Started

func (r *StockEventHandler) Started()

Watch has started.

func (*StockEventHandler) Updated

func (r *StockEventHandler) Updated(Event)

A model has been updated.

type Watch

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

Represents a watch.

func (*Watch) Alive

func (r *Watch) Alive() bool

The watch has not ended.

func (*Watch) End

func (r *Watch) End()

End the watch.

func (*Watch) Repair

func (r *Watch) Repair() (err error)

End the watch.

type WatchReader

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

Watch (event) reader.

func (*WatchReader) Repair

func (r *WatchReader) Repair() (status int, err error)

Repair.

func (*WatchReader) Terminate

func (r *WatchReader) Terminate()

Terminate.

type WatchWriter

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

Watch (event) writer.

func (*WatchWriter) Created

func (r *WatchWriter) Created(event model.Event)

A model has been created.

func (*WatchWriter) Deleted

func (r *WatchWriter) Deleted(event model.Event)

A model has been deleted.

func (*WatchWriter) End

func (r *WatchWriter) End()

An event watch has ended.

func (*WatchWriter) Error

func (r *WatchWriter) Error(err error)

An error has occurred delivering an event.

func (*WatchWriter) Parity

func (r *WatchWriter) Parity()

Watch has parity.

func (*WatchWriter) Started

func (r *WatchWriter) Started()

Watch has started.

func (*WatchWriter) Updated

func (r *WatchWriter) Updated(event model.Event)

A model has been updated.

type Watched

type Watched struct {
	WatchRequest bool
}

Watched (handler).

func (*Watched) Prepare

func (h *Watched) Prepare(ctx *gin.Context) int

Prepare the handler to fulfil the request. Set the `HasWatch` field using passed headers.

func (*Watched) Watch

func (r *Watched) Watch(
	ctx *gin.Context,
	db model.DB,
	m model.Model,
	rb ResourceBuilder) (err error)

Watch model.

type WebServer

type WebServer struct {
	// The optional port.  Default: 8080
	Port int
	// Allowed CORS origins.
	AllowedOrigins []string
	// Reference to the container.
	Container *container.Container
	// Handlers
	Handlers []RequestHandler

	// TLS.
	TLS struct {
		// Enabled.
		Enabled bool
		// Certificate path.
		Certificate string
		// Key path
		Key string
	}
	// contains filtered or unexported fields
}

Web server

func New

func New(c *container.Container, routes ...RequestHandler) *WebServer

Build new web server.

func (*WebServer) Start

func (w *WebServer) Start()

Start the web-server. Initializes `gin` with routes and CORS origins. Creates an http server to handle TLS