common

package

v1.1.5 Latest Latest Go to latest Published: Mar 2, 2022 License: MIT Imports: 26 Imported by: 7

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/textileio/go-threads

Links

Open Source Insights

Documentation ¶

Overview ¶

Package common provides utilities to set network options.

Index ¶

type LogstoreType
type NetBoostrapper
- func DefaultNetwork(opts ...NetOption) (NetBoostrapper, error)
type NetConfig
type NetOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type LogstoreType ¶ added in v1.0.1

type LogstoreType string

const (
	LogstoreInMemory   LogstoreType = "in-memory"
	LogstorePersistent LogstoreType = "persistent"
	LogstoreHybrid     LogstoreType = "hybrid"
)

type NetBoostrapper ¶

type NetBoostrapper interface {
	app.Net
	GetIpfsLite() *ipfslite.Peer
	Bootstrap(addrs []peer.AddrInfo)
}

func DefaultNetwork ¶

func DefaultNetwork(opts ...NetOption) (NetBoostrapper, error)

DefaultNetwork is a boostrapable default Net with sane defaults.

type NetConfig ¶

type NetConfig struct {
	NetPullingLimit           uint
	NetPullingStartAfter      time.Duration
	NetPullingInitialInterval time.Duration
	NetPullingInterval        time.Duration
	NoNetPulling              bool
	NoExchangeEdgesMigration  bool
	PubSub                    bool
	LSType                    LogstoreType
	BadgerRepoPath            string
	MongoUri                  string
	MongoDB                   string
	HostAddr                  ma.Multiaddr
	AnnounceAddr              ma.Multiaddr
	ConnManager               cconnmgr.ConnManager
	GRPCServerOptions         []grpc.ServerOption
	GRPCDialOptions           []grpc.DialOption
	Debug                     bool
}

type NetOption ¶

type NetOption func(c *NetConfig) error

func WithAnnounceAddr ¶ added in v1.1.3

func WithAnnounceAddr(addr ma.Multiaddr) NetOption

func WithConnectionManager ¶ added in v0.1.18

func WithConnectionManager(cm cconnmgr.ConnManager) NetOption

func WithNetBadgerPersistence ¶ added in v1.1.0

func WithNetBadgerPersistence(repoPath string) NetOption

func WithNetDebug ¶

func WithNetDebug(enabled bool) NetOption

func WithNetGRPCDialOptions ¶ added in v1.0.0

func WithNetGRPCDialOptions(opts ...grpc.DialOption) NetOption

func WithNetGRPCServerOptions ¶ added in v1.0.0

func WithNetGRPCServerOptions(opts ...grpc.ServerOption) NetOption

func WithNetHostAddr ¶

func WithNetHostAddr(addr ma.Multiaddr) NetOption

func WithNetLogstore ¶ added in v1.0.1

func WithNetLogstore(lt LogstoreType) NetOption

func WithNetMongoPersistence ¶ added in v1.1.0

func WithNetMongoPersistence(uri, db string) NetOption

func WithNetPubSub ¶ added in v1.0.0

func WithNetPubSub(enabled bool) NetOption

func WithNetPulling ¶ added in v1.1.0

func WithNetPulling(threadLimit uint, startAfter, initialInterval, interval time.Duration) NetOption

func WithNoExchangeEdgesMigration ¶ added in v1.1.2

func WithNoExchangeEdgesMigration(disable bool) NetOption

func WithNoNetPulling ¶ added in v1.1.0

func WithNoNetPulling(disable bool) NetOption

Source Files ¶

View all Source files

common.go

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