flux

Documentation

Index

• func HandleV6(api API)
• func HandleWebsocket(api API)
• func ParseFluxEvent(reader io.Reader) (flux.Event, error)
• type API
  • func NewAPI(e Exporter, logger *log.Logger) API
  • func (a *API) Listen(addr string) error
• type Exporter
• type Message
• type ReleaseManagerExporter
  • func (f *ReleaseManagerExporter) Send(_ context.Context, event flux.Event) error

Functions

func HandleV6

func HandleV6(api API)

HandleV6 Flux events

func HandleWebsocket

func HandleWebsocket(api API)

HandleWebsocket handles Flux WebSocket connections

func ParseFluxEvent

func ParseFluxEvent(reader io.Reader) (flux.Event, error)

ParseFluxEvent for doing flux event from Json into a flux Event struct.

Types

type API

type API struct {
	Server   *http.ServeMux
	Exporter Exporter
	Log      *log.Logger
}

API has the configuration necessary to run a flux API

func NewAPI

func NewAPI(e Exporter, logger *log.Logger) API

NewAPI initialize API configuration

func (*API) Listen

func (a *API) Listen(addr string) error

Listen on addr

type Exporter

type Exporter interface {
	// Send a message through the exporter.
	Send(c context.Context, event flux.Event) error
}

Exporter sends a formatted event to an upstream.

type Message

type Message struct {
	Event flux.Event
}

type ReleaseManagerExporter

type ReleaseManagerExporter struct {
	Log         *log.Logger
	Environment string
	Client      httpinternal.Client
}

func (*ReleaseManagerExporter) Send

func (f *ReleaseManagerExporter) Send(_ context.Context, event flux.Event) error