extension

Documentation

Index

• type Config
• type ConfigMap
• type Extension
• type REST
  • func (e *REST) ExecuteExtension(question *query.Question, ext, chn, cmd string, fsmDomain *fsm.Domain, ...) ([]query.Answer, error)
  • func (e *REST) GetAllExtensions() ([]string, error)
• type RPC
  • func (e *RPC) ExecuteExtension(question *query.Question, ext, chn, cmd string, fsmDomain *fsm.Domain, ...) ([]query.Answer, error)
  • func (e *RPC) GetAllExtensions() ([]string, error)
• type ServerMap
  • func New(extCfg ConfigMap) (ServerMap, error)
  • func (m *ServerMap) Add(server string, client Extension) error

Types

type Config

type Config struct {
	Type  string `mapstructure:"type"`
	Host  string `mapstructure:"host"`
	Port  int    `mapstructure:"port"`
	URL   string `mapstructure:"url"`
	Token string `mapstructure:"token"`
}

Config contains all the require parameters to communicate with an extension

type ConfigMap

type ConfigMap map[string]Config

ConfigMap of extension server names to their configs

type Extension

type Extension interface {
	GetAllExtensions() ([]string, error)
	ExecuteExtension(question *query.Question, extensionName, channel, command string, fsmDomain *fsm.Domain, machine *fsm.FSM) ([]query.Answer, error)
}

Extension is a service (REST or RPC) that executes commands and returns an answer to the Chatto bot. Extensions are written in any language and do whatever you want.

type REST

type REST struct {
	URL string
	// contains filtered or unexported fields
}

REST is a REST Client for extension command functions

func (*REST) ExecuteExtension

func (e *REST) ExecuteExtension(question *query.Question, ext, chn, cmd string, fsmDomain *fsm.Domain, machine *fsm.FSM) ([]query.Answer, error)

ExecuteExtension runs the requested command function and returns the response

func (*REST) GetAllExtensions

func (e *REST) GetAllExtensions() ([]string, error)

GetAllExtensions returns all command functions in the extension as a list of strings

type RPC

type RPC struct {
	Client *rpc.Client
}

RPC is an RPC Client for extension command functions

func (*RPC) ExecuteExtension

func (e *RPC) ExecuteExtension(question *query.Question, ext, chn, cmd string, fsmDomain *fsm.Domain, machine *fsm.FSM) ([]query.Answer, error)

ExecuteExtension runs the requested command function and returns the response

func (*RPC) GetAllExtensions

func (e *RPC) GetAllExtensions() ([]string, error)

GetAllExtensions returns all command functions in the extension as a list of strings

type ServerMap

type ServerMap map[string]Extension

ServerMap of extension server names to their clients

func New

func New(extCfg ConfigMap) (ServerMap, error)

New loads the extension configuration and connects to the server

func (*ServerMap) Add

func (m *ServerMap) Add(server string, client Extension) error

Add new extension name and client to the extension map