p2psender

package

v0.6.6 Latest Latest Go to latest Published: May 7, 2024 License: Apache-2.0, MIT Imports: 8 Imported by: 4

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

This section is empty.

This section is empty.

This section is empty.

type Option func(*config) error

Option is a function that sets a value in a config.

func WithExtraData(data []byte) Option

WithExtraData sets the extra data to include in the announce message.

func WithTopic(topic *pubsub.Topic) Option

WithTopic provides an existing pubsub topic.

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

Sender sends announce messages over pubsub.

func New(p2pHost host.Host, topicName string, options ...Option) (*Sender, error)

New creates a new Sender that sends announce messages over pubsub.

func (s *Sender) Close() error

Close stops the pubsub topic if the sender owns to topic.

func (s *Sender) Send(ctx context.Context, msg message.Message) error

Send sends the Message to the pubsub topic.

func (s *Sender) TopicName() string

TopicName returns the name of the topic that messages are sent to.