ldk

package module

Go to main page

Versions in this module

v1

v1.3.1

Sep 17, 2020

v1.3.0

Sep 2, 2020

Changes in this version

type ControllerGRPCHostClient

+ func (m *ControllerGRPCHostClient) UpdateWhisper(whisper Whisper, id string) error

type ControllerGRPCHostServer

+ func (m *ControllerGRPCHostServer) UpdateWhisper(ctx context.Context, req *proto.UpdateWhisperRequest) (*proto.Empty, error)

type ControllerHost

+ UpdateWhisper func(Whisper, string) error

type Source

+ Icon string

+ UploadID string

v1.2.0

Aug 21, 2020

Changes in this version

+ type Access string

+ const AccessOrganization

+ const AccessPublic

+ const AccessUnknown

+ const AccessUser

type Metadata

+ UploadID string

+ type OperatingSystem string

+ const OperatingSystemAny

+ const OperatingSystemLinux

+ const OperatingSystemMacOS

+ const OperatingSystemUnknown

+ const OperatingSystemWindows

v1.1.0

Aug 5, 2020

Changes in this version

+ var ErrUndocumentedStorageKey = errors.New("storage key is not present in documentation")

+ func ServeControllerPlugin(logger *Logger, controller Controller)

+ func ServeSensorPlugin(logger *Logger, sensor Sensor)

type ControllerGRPCClient

+ StorageDocumentation *StorageDocumentation

type ControllerGRPCHostClient

+ func (m *ControllerGRPCHostClient) StorageDelete(key string) error

+ func (m *ControllerGRPCHostClient) StorageDeleteAll() error

+ func (m *ControllerGRPCHostClient) StorageHasKey(key string) (bool, error)

+ func (m *ControllerGRPCHostClient) StorageKeys() ([]string, error)

+ func (m *ControllerGRPCHostClient) StorageRead(key string) (string, error)

+ func (m *ControllerGRPCHostClient) StorageReadAll() (map[string]string, error)

+ func (m *ControllerGRPCHostClient) StorageWrite(key, value string) error

type ControllerGRPCHostServer

+ StorageDocumentation *StorageDocumentation

+ func (m *ControllerGRPCHostServer) StorageDelete(ctx context.Context, req *proto.StorageDeleteRequest) (*proto.Empty, error)

+ func (m *ControllerGRPCHostServer) StorageDeleteAll(ctx context.Context, req *proto.Empty) (*proto.Empty, error)

+ func (m *ControllerGRPCHostServer) StorageHasKey(ctx context.Context, req *proto.StorageHasKeyRequest) (*proto.StorageHasKeyResponse, error)

+ func (m *ControllerGRPCHostServer) StorageKeys(ctx context.Context, req *proto.Empty) (*proto.StorageKeysResponse, error)

+ func (m *ControllerGRPCHostServer) StorageRead(ctx context.Context, req *proto.StorageReadRequest) (*proto.StorageReadResponse, error)

+ func (m *ControllerGRPCHostServer) StorageReadAll(ctx context.Context, req *proto.Empty) (*proto.StorageReadAllResponse, error)

+ func (m *ControllerGRPCHostServer) StorageWrite(ctx context.Context, req *proto.StorageWriteRequest) (*proto.Empty, error)

+ type ControllerGRPCPlugin struct

+ Impl Controller

+ func (p *ControllerGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

+ func (p *ControllerGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

type ControllerHost

+ StorageDelete func(string) error

+ StorageDeleteAll func() error

+ StorageHasKey func(string) (bool, error)

+ StorageKeys func() ([]string, error)

+ StorageRead func(string) (string, error)

+ StorageReadAll func() (map[string]string, error)

+ StorageWrite func(string, string) error

+ type Logger struct

+ func NewLogger(name string) *Logger

+ func (l *Logger) Debug(msg string, args ...interface{})

+ func (l *Logger) Error(msg string, args ...interface{})

+ func (l *Logger) Info(msg string, args ...interface{})

+ func (l *Logger) Logger() hclog.Logger

+ func (l *Logger) Trace(msg string, args ...interface{})

+ func (l *Logger) Warn(msg string, args ...interface{})

+ func (l *Logger) With(args ...interface{}) *Logger

type Metadata

+ Entrypoint []string

type SensorGRPCClient

+ StorageDocumentation *StorageDocumentation

type SensorGRPCHostClient

+ func (m *SensorGRPCHostClient) StorageDelete(key string) error

+ func (m *SensorGRPCHostClient) StorageDeleteAll() error

+ func (m *SensorGRPCHostClient) StorageHasKey(key string) (bool, error)

+ func (m *SensorGRPCHostClient) StorageKeys() ([]string, error)

+ func (m *SensorGRPCHostClient) StorageRead(key string) (string, error)

+ func (m *SensorGRPCHostClient) StorageReadAll() (map[string]string, error)

+ func (m *SensorGRPCHostClient) StorageWrite(key, value string) error

type SensorGRPCHostServer

+ StorageDocumentation *StorageDocumentation

+ func (m *SensorGRPCHostServer) StorageDelete(ctx context.Context, req *proto.StorageDeleteRequest) (*proto.Empty, error)

+ func (m *SensorGRPCHostServer) StorageDeleteAll(ctx context.Context, req *proto.Empty) (*proto.Empty, error)

+ func (m *SensorGRPCHostServer) StorageHasKey(ctx context.Context, req *proto.StorageHasKeyRequest) (*proto.StorageHasKeyResponse, error)

+ func (m *SensorGRPCHostServer) StorageKeys(ctx context.Context, req *proto.Empty) (*proto.StorageKeysResponse, error)

+ func (m *SensorGRPCHostServer) StorageRead(ctx context.Context, req *proto.StorageReadRequest) (*proto.StorageReadResponse, error)

+ func (m *SensorGRPCHostServer) StorageReadAll(ctx context.Context, req *proto.Empty) (*proto.StorageReadAllResponse, error)

+ func (m *SensorGRPCHostServer) StorageWrite(ctx context.Context, req *proto.StorageWriteRequest) (*proto.Empty, error)

+ type SensorGRPCPlugin struct

+ Impl Sensor

+ func (p *SensorGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

+ func (p *SensorGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

type SensorHost

+ StorageDelete func(string) error

+ StorageDeleteAll func() error

+ StorageHasKey func(string) (bool, error)

+ StorageKeys func() ([]string, error)

+ StorageRead func(string) (string, error)

+ StorageReadAll func() (map[string]string, error)

+ StorageWrite func(string, string) error

+ type StorageDocumentation struct

+ func (s *StorageDocumentation) Entries() map[string]StorageDocumentationEntry

+ func (s *StorageDocumentation) HasKey(key string) bool

+ func (s *StorageDocumentation) Keys() []string

+ func (s *StorageDocumentation) UnmarshalJSON(data []byte) error

+ type StorageDocumentationEntry struct

+ Description string

+ Name string

+ Secure bool

v1.0.1

Jul 14, 2020

v1.0.0

Jul 14, 2020

Changes in this version

+ const CategoryController

+ const CategoryIntelligence

+ const CategorySensor

+ const CategorySidekick

+ const CategoryUnknown

+ var ControllerPluginMap = map[string]plugin.Plugin

+ var Handshake = plugin.HandshakeConfig

+ var SensorPluginMap = map[string]plugin.Plugin

+ func IsInstallMode() bool

+ func IsUninstallMode() bool

+ type Category int

+ func (c *Category) UnmarshalJSON(b []byte) error

+ func (c *Category) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (c Category) MarshalJSON() ([]byte, error)

+ func (c Category) MarshalYAML() (interface{}, error)

+ func (c Category) String() string

+ type Config map[string]string

+ type Controller interface

+ Config func() (map[string]string, error)

+ OnEvent func(Event) error

+ SetConfig func(map[string]string) error

+ Start func(ControllerHost) error

+ Stop func() error

+ type ControllerGRPCClient struct

+ Metadata Metadata

+ func (m *ControllerGRPCClient) Config() (map[string]string, error)

+ func (m *ControllerGRPCClient) OnEvent(event Event) error

+ func (m *ControllerGRPCClient) SetConfig(config map[string]string) error

+ func (m *ControllerGRPCClient) Start(host ControllerHost) error

+ func (m *ControllerGRPCClient) Stop() error

+ type ControllerGRPCHostClient struct

+ func (m *ControllerGRPCHostClient) EmitWhisper(whisper Whisper) error

+ type ControllerGRPCHostServer struct

+ Impl ControllerHost

+ Metadata Metadata

+ func (m *ControllerGRPCHostServer) EmitWhisper(ctx context.Context, req *proto.EmitWhisperRequest) (*proto.Empty, error)

+ type ControllerGRPCPPlugin struct

+ Impl Controller

+ func (p *ControllerGRPCPPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

+ func (p *ControllerGRPCPPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

+ type ControllerGRPCServer struct

+ Impl Controller

+ func (m *ControllerGRPCServer) Config(ctx context.Context, req *proto.Empty) (*proto.ConfigResponse, error)

+ func (m *ControllerGRPCServer) OnEvent(ctx context.Context, req *proto.OnEventRequest) (*proto.Empty, error)

+ func (m *ControllerGRPCServer) SetConfig(ctx context.Context, req *proto.SetConfigRequest) (*proto.Empty, error)

+ func (m *ControllerGRPCServer) Start(ctx context.Context, req *proto.StartRequest) (*proto.Empty, error)

+ func (m *ControllerGRPCServer) Stop(ctx context.Context, req *proto.Empty) (*proto.Empty, error)

+ type ControllerHost interface

+ EmitWhisper func(Whisper) error

+ type Event struct

+ Data map[string]string

+ Source Source

+ func NewTextEvent(text string) Event

+ func (e *Event) Text() string

+ type Metadata struct

+ Author string

+ Category Category

+ Created time.Time

+ Description string

+ ID string

+ Icon string

+ Name string

+ Organization string

+ Specification string

+ Updated time.Time

+ Version string

+ type Sensor interface

+ Config func() (Config, error)

+ OnEvent func(Event) error

+ SetConfig func(Config) error

+ Start func(SensorHost) error

+ Stop func() error

+ type SensorGRPCClient struct

+ Metadata Metadata

+ func (m *SensorGRPCClient) Config() (Config, error)

+ func (m *SensorGRPCClient) OnEvent(event Event) error

+ func (m *SensorGRPCClient) SetConfig(config Config) error

+ func (m *SensorGRPCClient) Start(host SensorHost) error

+ func (m *SensorGRPCClient) Stop() error

+ type SensorGRPCHostClient struct

+ func (m *SensorGRPCHostClient) EmitEvent(event Event) error

+ type SensorGRPCHostServer struct

+ Impl SensorHost

+ Metadata Metadata

+ func (m *SensorGRPCHostServer) EmitEvent(ctx context.Context, req *proto.EmitEventRequest) (*proto.Empty, error)

+ type SensorGRPCPPlugin struct

+ Impl Sensor

+ func (p *SensorGRPCPPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

+ func (p *SensorGRPCPPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

+ type SensorGRPCServer struct

+ Impl Sensor

+ func (m *SensorGRPCServer) Config(ctx context.Context, req *proto.Empty) (*proto.ConfigResponse, error)

+ func (m *SensorGRPCServer) OnEvent(ctx context.Context, req *proto.OnEventRequest) (*proto.Empty, error)

+ func (m *SensorGRPCServer) SetConfig(ctx context.Context, req *proto.SetConfigRequest) (*proto.Empty, error)

+ func (m *SensorGRPCServer) Start(ctx context.Context, req *proto.StartRequest) (*proto.Empty, error)

+ func (m *SensorGRPCServer) Stop(ctx context.Context, req *proto.Empty) (*proto.Empty, error)

+ type SensorHost interface

+ EmitEvent func(Event) error

+ type Source struct

+ Author string

+ Category Category

+ ID string

+ Name string

+ Organization string

+ Version string

+ type Style struct

+ BackgroundColor string

+ HighlightColor string

+ PrimaryColor string

+ type Whisper struct

+ CreatedAt time.Time

+ ID string

+ Icon string

+ Label string

+ Markdown string

+ Source Source

+ Style Style

+ func NewWhisper(markdown string, label string, icon string, style Style) (Whisper, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL