pubsub

Documentation

Overview

pubsub a publish subscribe client for IPFS PubSub

Index

• func NewMessageEvent(topic string, content []byte) events.Event
• type EventPayload
  • func NewEventPayload(payload []byte) *EventPayload
• type Interface
  • func NewPubSub(coreAPI coreapi.CoreAPI, id peer.ID, opts *Options) (Interface, error)
• type MessageEvent
• type Options
• type Subscription
  • func NewSubscription(ctx context.Context, ipfs coreapi.CoreAPI, topic string, opts *Options) (Subscription, error)

Functions

func NewMessageEvent

func NewMessageEvent(topic string, content []byte) events.Event

Creates a new Message event

Types

type EventPayload

type EventPayload struct {
	Payload []byte
}

EventPayload An event received on new messages

func NewEventPayload

func NewEventPayload(payload []byte) *EventPayload

NewEventPayload Creates a new Message event

type Interface

type Interface interface {
	// Subscribe Subscribes to a topic
	Subscribe(ctx context.Context, topic string) (Subscription, error)

	// Unsubscribe Unsubscribe from a topic
	Unsubscribe(topic string) error

	// Close Unsubscribe from all topics
	Close() error

	// Publish Posts a new message on a topic
	Publish(ctx context.Context, topic string, message []byte) error
}

func NewPubSub

func NewPubSub(coreAPI coreapi.CoreAPI, id peer.ID, opts *Options) (Interface, error)

NewPubSub Creates a new pubsub client

type MessageEvent

type MessageEvent struct {
	Topic   string
	Content []byte
}

MessageEvent Indicates a new message posted on a pubsub topic

type Options

type Options struct {
	Logger *zap.Logger
	Tracer trace.Tracer
}

type Subscription

type Subscription interface {
	events.EmitterInterface
	io.Closer
}

Subscription is a pub sub subscription to a topic

func NewSubscription

func NewSubscription(ctx context.Context, ipfs coreapi.CoreAPI, topic string, opts *Options) (Subscription, error)

NewSubscription Creates a new pub sub subscription