engine

Documentation

Index

• func NewLogEntry(step flows.Step, action flows.Action, event flows.Event) flows.LogEntry
• func NewSession(assetCache *AssetCache, assetServer AssetServer) flows.Session
• func NewSessionAssets(cache *AssetCache, server AssetServer) flows.SessionAssets
• func ReadSession(assetCache *AssetCache, assetServer AssetServer, data json.RawMessage) (flows.Session, error)
• type AssetCache
  • func NewAssetCache(maxSize int64, pruneItems int, fetchUserAgent string) *AssetCache
  • func (c *AssetCache) Include(data json.RawMessage) error
  • func (c *AssetCache) Shutdown()
• type AssetServer
  • func NewAssetServer(authHeader string, typeURLs map[assetType]string) AssetServer
  • func NewMockAssetServer() AssetServer
  • func ReadAssetServer(data json.RawMessage) (AssetServer, error)

Functions

func NewLogEntry

func NewLogEntry(step flows.Step, action flows.Action, event flows.Event) flows.LogEntry

NewLogEntry creates a new event log entry

func NewSession

func NewSession(assetCache *AssetCache, assetServer AssetServer) flows.Session

NewSession creates a new session

func NewSessionAssets

func NewSessionAssets(cache *AssetCache, server AssetServer) flows.SessionAssets

NewSessionAssets creates a new session assets instance with the provided base URLs

func ReadSession

func ReadSession(assetCache *AssetCache, assetServer AssetServer, data json.RawMessage) (flows.Session, error)

ReadSession decodes a session from the passed in JSON

Types

type AssetCache

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

AssetCache fetches and caches assets for the engine

func NewAssetCache

func NewAssetCache(maxSize int64, pruneItems int, fetchUserAgent string) *AssetCache

NewAssetCache creates a new asset cache

func (*AssetCache) Include

func (c *AssetCache) Include(data json.RawMessage) error

Include loads assets from the given raw JSON into the cache

func (*AssetCache) Shutdown

func (c *AssetCache) Shutdown()

Shutdown shuts down this asset cache

type AssetServer

type AssetServer interface {
	// contains filtered or unexported methods
}

AssetServer describes the asset server we'll fetch missing assets from

func NewAssetServer

func NewAssetServer(authHeader string, typeURLs map[assetType]string) AssetServer

NewAssetServer creates a new asset server

func NewMockAssetServer

func NewMockAssetServer() AssetServer

NewMockAssetServer creates a new mocked asset server for testing

func ReadAssetServer

func ReadAssetServer(data json.RawMessage) (AssetServer, error)

ReadAssetServer reads an asset server fronm the given JSON