oneonone

Documentation

Overview

oneonone is a pubsub channel for communication between two peers

Index

• Constants
• type Channel
  • func NewChannel(ctx context.Context, ipfs coreapi.CoreAPI, pid p2pcore.PeerID, opts *Options) (Channel, error)
• type EventMessage
  • func NewEventMessage(payload []byte) *EventMessage
• type Options

Constants

const PROTOCOL = "ipfs-pubsub-direct-channel/v1"

Types

type Channel

type Channel interface {
	events.EmitterInterface

	// ID Returns the Channel ID (pubsub topic)
	ID() string

	// Peers Returns the lists of peers expected to be in the channel
	Peers() []p2pcore.PeerID

	// Connect Waits for the other peer to be connected
	Connect(context.Context) error

	// Sends Sends a message to the other peer
	Send(context.Context, []byte) error

	// Close Closes the connection
	Close() error
}

Channel Channel is a pubsub used for a direct communication between peers new messages are received via events

func NewChannel

func NewChannel(ctx context.Context, ipfs coreapi.CoreAPI, pid p2pcore.PeerID, opts *Options) (Channel, error)

NewChannel Creates a new pubsub topic for communication between two peers

type EventMessage

type EventMessage struct {
	Payload []byte
}

EventMessage An event received on new messages

func NewEventMessage

func NewEventMessage(payload []byte) *EventMessage

NewEventMessage Creates a new Message event

type Options

type Options struct {
	Logger *zap.Logger
}