meta

Documentation

Index

• Constants
• type ExtendedPluginMeta
• type ModeList
  • func QueryPluginModes(pluginFilename string) (ModeList, error)
• type ModeSet
  • func (m ModeSet) MarshalJSON() ([]byte, error)
• type PluginMeta
  • func ReadFile(f file) (PluginMeta, error)
  • func ReadMetadata() PluginMeta
  • func ReadPath(path string) (PluginMeta, error)
  • func (pm PluginMeta) Filename() string
• type PluginMode
  • func (m PluginMode) IsValid() bool
• type Scheme
  • func NewScheme(opts ...SchemeOption) Scheme
• type SchemeFunc
• type SchemeOption
  • func WithMode(mode PluginMode) SchemeOption
• type SchemeOptions

Constants

const (
	PluginModeEnvVar = "OPNI_PLUGIN_MODE"
)

Types

type ExtendedPluginMeta

type ExtendedPluginMeta struct {
	ModeList ModeList
}

type ModeList

type ModeList struct {
	Modes []PluginMode `json:"modes"`
}

func QueryPluginModes

func QueryPluginModes(pluginFilename string) (ModeList, error)

type ModeSet

type ModeSet map[PluginMode]SchemeFunc

func (ModeSet) MarshalJSON

func (m ModeSet) MarshalJSON() ([]byte, error)

type PluginMeta

type PluginMeta struct {
	BinaryPath string
	GoVersion  string
	Module     string

	// Extended metadata not populated from build info.
	ExtendedMetadata *ExtendedPluginMeta
}

func ReadFile

func ReadFile(f file) (PluginMeta, error)

Reads relevant metadata from an opened file. Does not change the i/o offset of the file.

func ReadMetadata

func ReadMetadata() PluginMeta

func ReadPath

func ReadPath(path string) (PluginMeta, error)

Reads relevant metadata from the binary at the given path.

func (PluginMeta) Filename

func (pm PluginMeta) Filename() string

type PluginMode

type PluginMode string

const (
	ModeGateway   PluginMode = "gateway"
	ModeAgent     PluginMode = "agent"
	ModeListModes PluginMode = "__list_modes__"
)

func (PluginMode) IsValid

func (m PluginMode) IsValid() bool

type Scheme

type Scheme interface {
	Add(string, plugin.Plugin)
	PluginMap() map[string]plugin.Plugin
	Mode() PluginMode
}

func NewScheme

func NewScheme(opts ...SchemeOption) Scheme

type SchemeFunc

type SchemeFunc = func(context.Context) Scheme

type SchemeOption

type SchemeOption func(*SchemeOptions)

func WithMode

func WithMode(mode PluginMode) SchemeOption

type SchemeOptions

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