client

package

v0.0.0-...-57a6056 Latest Latest Go to latest Published: May 15, 2020 License: MIT Imports: 8 Imported by: 0

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/drand/drand

Documentation ¶

Index ¶

type Client
- func NewWithPubsub(ps *pubsub.PubSub, networkName string) (*Client, error)
- func (c *Client) Close() error
- func (c *Client) Sub(ch chan drand.PublicRandResponse) UnsubFunc
type UnsubFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

func NewWithPubsub ¶

func NewWithPubsub(ps *pubsub.PubSub, networkName string) (*Client, error)

NewWtihPubsub creates a gossip randomness client.

func (*Client) Close ¶

func (c *Client) Close() error

Close stops Client, cancels PubSub subscription and closes the topic.

func (*Client) Sub ¶

func (c *Client) Sub(ch chan drand.PublicRandResponse) UnsubFunc

Sub subscribes to notfications about new randomness. Client instnace owns the channel after it is passed to Sub function, thus the channel should not be closed by library user

It is recommended to use a buffered channel. If the channel is full, notification about randomness will be dropped.

Notification channels will be closed when the client is Closed

type UnsubFunc ¶

type UnsubFunc func()

Source Files ¶

View all Source files

client.go

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