client

package

v0.2.1 Latest Latest Go to latest Published: Aug 5, 2021 License: MIT Imports: 18 Imported by: 1

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/cryptoscope/ssb

Links

Open Source Insights

Documentation ¶

Overview ¶

Package client is a a simple muxrpc interface to common ssb methods, similar to npm:ssb-client

Index ¶

type Client
type NamesGetResult
- func (ngr NamesGetResult) GetCommonName(feed refs.FeedRef) (string, bool)
type Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	muxrpc.Endpoint
	// contains filtered or unexported fields
}

func FromEndpoint ¶

func FromEndpoint(edp muxrpc.Endpoint, opts ...Option) (*Client, error)

func NewTCP ¶

func NewTCP(own ssb.KeyPair, remote net.Addr, opts ...Option) (*Client, error)

func NewUnix ¶

func NewUnix(path string, opts ...Option) (*Client, error)

func (Client) BlobsGet ¶

func (c Client) BlobsGet(ref refs.BlobRef) (io.Reader, error)

func (Client) BlobsHas ¶

func (c Client) BlobsHas(ref refs.BlobRef) (bool, error)

func (Client) BlobsWant ¶

func (c Client) BlobsWant(ref refs.BlobRef) error

func (Client) Close ¶

func (c Client) Close() error

func (Client) CreateHistoryStream ¶

func (c Client) CreateHistoryStream(o message.CreateHistArgs) (*muxrpc.ByteSource, error)

func (Client) CreateLogStream ¶

func (c Client) CreateLogStream(o message.CreateLogArgs) (*muxrpc.ByteSource, error)

func (Client) MessagesByType ¶

func (c Client) MessagesByType(o message.MessagesByTypeArgs) (*muxrpc.ByteSource, error)

func (Client) NamesGet ¶

func (c Client) NamesGet() (NamesGetResult, error)

func (Client) NamesImageFor ¶

func (c Client) NamesImageFor(ref refs.FeedRef) (refs.BlobRef, error)

func (Client) NamesSignifier ¶

func (c Client) NamesSignifier(ref refs.FeedRef) (string, error)

func (Client) PrivatePublish ¶

func (c Client) PrivatePublish(v interface{}, recps ...refs.FeedRef) (refs.MessageRef, error)

func (Client) PrivateRead ¶

func (c Client) PrivateRead() (*muxrpc.ByteSource, error)

func (Client) Publish ¶

func (c Client) Publish(v interface{}) (refs.MessageRef, error)

func (Client) ReplicateUpTo ¶

func (c Client) ReplicateUpTo() (*muxrpc.ByteSource, error)

func (Client) TanglesThread ¶ added in v0.2.1

func (c Client) TanglesThread(o message.TanglesArgs) (*muxrpc.ByteSource, error)

func (Client) Whoami ¶

func (c Client) Whoami() (refs.FeedRef, error)

type NamesGetResult ¶

type NamesGetResult map[string]map[string]string

func (NamesGetResult) GetCommonName ¶

func (ngr NamesGetResult) GetCommonName(feed refs.FeedRef) (string, bool)

type Option ¶

type Option func(*Client) error

func WithContext ¶

func WithContext(ctx context.Context) Option

func WithLogger ¶

func WithLogger(l log.Logger) Option

func WithSHSAppKey ¶

func WithSHSAppKey(appKey string) Option

Source Files ¶

View all Source files

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