threads

package module
v0.0.0-...-8519790 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 18, 2019 License: MIT Imports: 37 Imported by: 0

README

go-textile-threads

Made by Textile Chat on Slack GitHub license Go Report Card CircleCI branch standard-readme compliant

Textile's threads implementation in Go

Go to the docs for more about Textile.

Join us on our public Slack channel for news, discussions, and status updates. Check out our blog for the latest posts and announcements.

Table of Contents

Install

go get github.com/textileio/go-textile-threads

Usage

Go to https://godoc.org/github.com/textileio/go-textile-threads.

Contributing

This project is a work in progress. As such, there's a few things you can do right now to help out:

  • Ask questions! We'll try to help. Be sure to drop a note (on the above issue) if there is anything you'd like to work on and we'll update the issue to let others know. Also get in touch on Slack.
  • Open issues, file issues, submit pull requests!
  • Perform code reviews. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
  • Take a look at the code. Contributions here that would be most helpful are top-level comments about how it should look based on your understanding. Again, the more eyes the better.
  • Add tests. There can never be enough tests.

Before you get started, be sure to read our contributors guide and our contributor covenant code of conduct.

Changelog

Changelog is published to Releases.

License

MIT

Documentation

Index

Constants

View Source
const (
	// Thread is the protocol slug.
	Thread = "thread"
	// ThreadCode is the protocol code.
	ThreadCode = 406
	// ThreadsVersion is the current protocol version.
	ThreadVersion = "0.0.1"
	// ThreadProtocol is the threads protocol tag.
	ThreadProtocol protocol.ID = "/" + Thread + "/" + ThreadVersion
)

Variables

View Source
var (

	// MaxPullLimit is the maximum page size for pulling records.
	MaxPullLimit = 10000

	// InitialPullInterval is the interval between automatic log pulls.
	InitialPullInterval = time.Second

	// PullInterval is the interval between automatic log pulls.
	PullInterval = time.Second * 10
)

Functions

func NewThreads

func NewThreads(
	ctx context.Context,
	h host.Host,
	bstore bs.Blockstore,
	ds format.DAGService,
	ts tstore.Threadstore,
	conf Config,
) (tserv.Threadservice, error)

NewThreads creates an instance of threads from the given host and thread store.

func NewThreadstore

NewThreadstore creates a new thread store from the given books.

Types

type Config

type Config struct {
	ProxyAddr ma.Multiaddr
	Debug     bool
}

Config is used to specify thread instance options.

Directories

Path Synopsis
api
pb
Package eventstore provides a Store which manage models
Package eventstore provides a Store which manage models
examples

Jump to

Keyboard shortcuts

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