serve

Documentation

Index

• Constants
• type PackageJSON
• type PluginOption
  • func WithArgs(args ...string) PluginOption
  • func WithDestinationV0V1Server() PluginOption
  • func WithTestListener() PluginOption
• type PluginServe
  • func Plugin(p *plugin.Plugin, opts ...PluginOption) *PluginServe
  • func (s *PluginServe) Serve(ctx context.Context) error
• type TargetBuild

Constants

const (
	MaxMsgSize = 100 * 1024 * 1024 // 100 MiB
)

Types

type PackageJSON

type PackageJSON struct {
	SchemaVersion    int                `json:"schema_version"`
	Team             string             `json:"team"`
	Kind             plugin.Kind        `json:"kind"`
	Name             string             `json:"name"`
	Message          string             `json:"message"`
	Version          string             `json:"version"`
	Protocols        []int              `json:"protocols"`
	SupportedTargets []TargetBuild      `json:"supported_targets"`
	PackageType      plugin.PackageType `json:"package_type"`
}

PackageJSON is the package.json file inside the dist directory. It is used by the CloudQuery package command to be able to package the plugin with all the needed metadata.

type PluginOption

type PluginOption func(*PluginServe)

func WithArgs

func WithArgs(args ...string) PluginOption

WithArgs used to serve the plugin with predefined args instead of os.Args

func WithDestinationV0V1Server

func WithDestinationV0V1Server() PluginOption

WithDestinationV0V1Server is used to include destination v0 and v1 server to work with older sources

func WithTestListener

func WithTestListener() PluginOption

WithTestListener means that the plugin will be served with an in-memory listener available via testListener() method instead of a network listener.

type PluginServe

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

func Plugin

func Plugin(p *plugin.Plugin, opts ...PluginOption) *PluginServe

func (*PluginServe) Serve

func (s *PluginServe) Serve(ctx context.Context) error

type TargetBuild

type TargetBuild struct {
	OS       string `json:"os"`
	Arch     string `json:"arch"`
	Path     string `json:"path"`
	Checksum string `json:"checksum"`
}