bots

Documentation

Index

• type BotIpfsHandler
  • func (mip BotIpfsHandler) Add(data []byte, encrypt bool) (hash string, key string, err error)
  • func (mip BotIpfsHandler) Get(pth string, key string) ([]byte, error)
• type Datastore
  • func (kv Datastore) Close() error
  • func (kv Datastore) Delete(key ds.Key) error
  • func (kv Datastore) Get(key ds.Key) (data []byte, err error)
  • func (kv Datastore) GetSize(key ds.Key) (size int, err error)
  • func (kv Datastore) Has(key ds.Key) (exists bool, err error)
  • func (kv Datastore) Put(key ds.Key, data []byte) error
  • func (kv Datastore) Query(query.Query) (query.Results, error)
• type Service
  • func NewService(node *core.Textile) *Service
  • func (s *Service) Create(botID string, botVersion int, name string, params map[string]string, ...)
  • func (s *Service) Delete(botID string, q []byte) (shared.Response, error)
  • func (s *Service) Exists(id string) bool
  • func (s *Service) Get(botID string, q []byte) (shared.Response, error)
  • func (s *Service) List() *pb.ActiveBotList
  • func (s *Service) Post(botID string, q []byte, body []byte) (shared.Response, error)
  • func (s *Service) Put(botID string, q []byte, body []byte) (shared.Response, error)
  • func (s *Service) RunAll(repoPath string, bots []string)

Types

type BotIpfsHandler

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

BotIpfsHandler implements shared.IpfsHandler. Extends it by hanging on the the botID

func (BotIpfsHandler) Add

func (mip BotIpfsHandler) Add(data []byte, encrypt bool) (hash string, key string, err error)

Add allows a bot to add data to IPFS. currently it does not pin the data, only adds.

func (BotIpfsHandler) Get

func (mip BotIpfsHandler) Get(pth string, key string) ([]byte, error)

Get allows a bot to get IPFS data by the cid/path. Allows optional key for decryption on the fly

type Datastore

type Datastore struct {
	Namespace ds.Key
	// contains filtered or unexported fields
}

Datastore implements shared.Botstore. Extends it with BotID and BotVersion

func (Datastore) Close

func (kv Datastore) Close() error

Close not used by bots but required by ds.Datastore

func (Datastore) Delete

func (kv Datastore) Delete(key ds.Key) error

Delete allows a bot to delete a value in the kv store

func (Datastore) Get

func (kv Datastore) Get(key ds.Key) (data []byte, err error)

Get allows a bot to get a value by string. It responds with the version of the bot that wrote the data.

func (Datastore) GetSize

func (kv Datastore) GetSize(key ds.Key) (size int, err error)

GetSize returns the size of a value

func (Datastore) Has

func (kv Datastore) Has(key ds.Key) (exists bool, err error)

Has returns true if key exists

func (Datastore) Put

func (kv Datastore) Put(key ds.Key, data []byte) error

Put allows a bot to add a key-val to the store

func (Datastore) Query

func (kv Datastore) Query(query.Query) (query.Results, error)

Query not used by bots but required by ds.Datastore

type Service

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

Service holds a map to all running bots on this node

func NewService

func NewService(node *core.Textile) *Service

NewService returns a new bot service

func (*Service) Create

func (s *Service) Create(botID string, botVersion int, name string, params map[string]string, pth string)

Create configures the Bot rpc instance

func (*Service) Delete

func (s *Service) Delete(botID string, q []byte) (shared.Response, error)

Delete runs the bot.Delete method

func (*Service) Exists

func (s *Service) Exists(id string) bool

Exists is a helper to check if a bot exists

func (*Service) Get

func (s *Service) Get(botID string, q []byte) (shared.Response, error)

Get runs the bot.Get method

func (*Service) List

func (s *Service) List() *pb.ActiveBotList

List returns the id of all running bots

func (*Service) Post

func (s *Service) Post(botID string, q []byte, body []byte) (shared.Response, error)

Post runs the bot.Post method

func (*Service) Put

func (s *Service) Put(botID string, q []byte, body []byte) (shared.Response, error)

Put runs the bot.Put method

func (*Service) RunAll

func (s *Service) RunAll(repoPath string, bots []string)

RunAll runs a list of bots from Textile config