tinder

package
v2.94.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 23, 2020 License: Apache-2.0, MIT Imports: 27 Imported by: 0

Documentation

Overview

Package tinder is a multi-driver service backed by a cache.

┌───────────────────────────────────────────────────┐
│ Tinder                                            │        ┌───────────────────────┐

┌───────────────┐ │ │ ┌────▶│ Driver DHT Ipfs │ │ Advertise │▶┼───┐ ┌────────────────┐ │ │ └───────────────────────┘ └───────────────┘ │ │ │ Backoff Cache │ │ │ ┌───────────────────────┐ ┌───────────────┐ │ ├────▶│ Discover │──┐ ┌───────────────┐ │ ├────▶│ Driver DHT Berty │ │ FindPeers │▶┼───┘ └────────────────┘ │ │Driver Manager │ │ │ └───────────────────────┘ └───────────────┘ │ ┌──────────────┴──▶│ (MultiDriver) │─┼──┤ ┌───────────────────────┐ ┌───────────────┐ │ │ └───────────────┘ │ ├────▶│Driver RendezVousPoint │ │ Unregister │▶┼──────────────┘ │ │ └───────────────────────┘ └───────────────┘ │ │ │ ┌───────────────────────┐

│                                                   │  └────▶│Driver Local (ble/mdns)│
└───────────────────────────────────────────────────┘        └───────────────────────┘

Index

Constants

View Source
const ScheduleKey = "Schedule"

Variables

View Source
var (
	ErrInvalidLengthRecords        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowRecords          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupRecords = fmt.Errorf("proto: unexpected end of group")
)

Functions

func Schedule

func Schedule(t time.Time) p2p_discovery.Option

Schedule advertise at the given time

Types

type DHTDriver added in v2.50.0

type DHTDriver struct {
	p2p_discovery.Discovery
	Unregisterer
}

func (*DHTDriver) Name added in v2.50.0

func (d *DHTDriver) Name() string

type Driver

type Driver interface {
	p2p_discovery.Discovery
	Unregisterer

	Name() string
}

Driver is a Discovery with a unregister method

func ComposeDriver

func ComposeDriver(name string, advertiser p2p_discovery.Advertiser, discover p2p_discovery.Discoverer, unregister Unregisterer) Driver

func NewDHTDriver

func NewDHTDriver(d *dht.IpfsDHT) Driver

func NewLocalDiscovery added in v2.94.0

func NewLocalDiscovery(logger *zap.Logger, host host.Host, rng *mrand.Rand) Driver

func NewMockedDriverClient

func NewMockedDriverClient(host p2p_host.Host, server *MockDriverServer) Driver

func NewMultiDriver

func NewMultiDriver(logger *zap.Logger, drivers ...Driver) Driver

func NewRendezvousDiscovery

func NewRendezvousDiscovery(logger *zap.Logger, host host.Host, rdvPeer peer.ID, rng *mrand.Rand) Driver

type MockDriverServer

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

func NewMockedDriverServer

func NewMockedDriverServer() *MockDriverServer

func (*MockDriverServer) Advertise

func (s *MockDriverServer) Advertise(ns string, info p2p_peer.AddrInfo, ttl time.Duration) (time.Duration, error)

func (*MockDriverServer) FindPeers

func (s *MockDriverServer) FindPeers(ns string, limit int) (<-chan p2p_peer.AddrInfo, error)

func (*MockDriverServer) HasPeerRecord

func (s *MockDriverServer) HasPeerRecord(ns string, pid p2p_peer.ID) bool

func (*MockDriverServer) Reset

func (s *MockDriverServer) Reset()

func (*MockDriverServer) Unregister

func (s *MockDriverServer) Unregister(ns string, pid p2p_peer.ID)

type MultiDriver

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

MultiDriver is a simple driver manager, that forward request across multiple driver

func (*MultiDriver) Advertise

func (md *MultiDriver) Advertise(ctx context.Context, ns string, opts ...p2p_discovery.Option) (time.Duration, error)

Advertise simply dispatch Advertise request across all the drivers

func (*MultiDriver) FindPeers

func (md *MultiDriver) FindPeers(ctx context.Context, ns string, opts ...p2p_discovery.Option) (<-chan p2p_peer.AddrInfo, error)

FindPeers for MultiDriver doesn't care about duplicate peers, his only job here is to dispatch FindPeers request across all the drivers.

func (*MultiDriver) Name added in v2.50.0

func (*MultiDriver) Name() string

func (*MultiDriver) Unregister

func (md *MultiDriver) Unregister(ctx context.Context, ns string) error

type Record added in v2.94.0

type Record struct {
	Cid                  string   `protobuf:"bytes,1,opt,name=cid,proto3" json:"cid,omitempty"`
	Expire               int64    `protobuf:"varint,2,opt,name=expire,proto3" json:"expire,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*Record) Descriptor added in v2.94.0

func (*Record) Descriptor() ([]byte, []int)

func (*Record) GetCid added in v2.94.0

func (m *Record) GetCid() string

func (*Record) GetExpire added in v2.94.0

func (m *Record) GetExpire() int64

func (*Record) Marshal added in v2.94.0

func (m *Record) Marshal() (dAtA []byte, err error)

func (*Record) MarshalTo added in v2.94.0

func (m *Record) MarshalTo(dAtA []byte) (int, error)

func (*Record) MarshalToSizedBuffer added in v2.94.0

func (m *Record) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Record) ProtoMessage added in v2.94.0

func (*Record) ProtoMessage()

func (*Record) Reset added in v2.94.0

func (m *Record) Reset()

func (*Record) Size added in v2.94.0

func (m *Record) Size() (n int)

func (*Record) String added in v2.94.0

func (m *Record) String() string

func (*Record) Unmarshal added in v2.94.0

func (m *Record) Unmarshal(dAtA []byte) error

func (*Record) XXX_DiscardUnknown added in v2.94.0

func (m *Record) XXX_DiscardUnknown()

func (*Record) XXX_Marshal added in v2.94.0

func (m *Record) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Record) XXX_Merge added in v2.94.0

func (m *Record) XXX_Merge(src proto.Message)

func (*Record) XXX_Size added in v2.94.0

func (m *Record) XXX_Size() int

func (*Record) XXX_Unmarshal added in v2.94.0

func (m *Record) XXX_Unmarshal(b []byte) error

type Records added in v2.94.0

type Records struct {
	Records              []*Record `protobuf:"bytes,1,rep,name=records,proto3" json:"records,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

func (*Records) Descriptor added in v2.94.0

func (*Records) Descriptor() ([]byte, []int)

func (*Records) GetRecords added in v2.94.0

func (m *Records) GetRecords() []*Record

func (*Records) Marshal added in v2.94.0

func (m *Records) Marshal() (dAtA []byte, err error)

func (*Records) MarshalTo added in v2.94.0

func (m *Records) MarshalTo(dAtA []byte) (int, error)

func (*Records) MarshalToSizedBuffer added in v2.94.0

func (m *Records) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Records) ProtoMessage added in v2.94.0

func (*Records) ProtoMessage()

func (*Records) Reset added in v2.94.0

func (m *Records) Reset()

func (*Records) Size added in v2.94.0

func (m *Records) Size() (n int)

func (*Records) String added in v2.94.0

func (m *Records) String() string

func (*Records) Unmarshal added in v2.94.0

func (m *Records) Unmarshal(dAtA []byte) error

func (*Records) XXX_DiscardUnknown added in v2.94.0

func (m *Records) XXX_DiscardUnknown()

func (*Records) XXX_Marshal added in v2.94.0

func (m *Records) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Records) XXX_Merge added in v2.94.0

func (m *Records) XXX_Merge(src proto.Message)

func (*Records) XXX_Size added in v2.94.0

func (m *Records) XXX_Size() int

func (*Records) XXX_Unmarshal added in v2.94.0

func (m *Records) XXX_Unmarshal(b []byte) error

type Routing added in v2.50.0

type Routing interface {
	p2p_routing.Routing

	Driver
}

func NewRouting added in v2.50.0

func NewRouting(logger *zap.Logger, name string, r p2p_routing.Routing, drivers ...Driver) Routing

type Service

type Service interface {
	Driver
}

Tinder service is a simple driver backed by a cache,

func NewService

func NewService(logger *zap.Logger, drivers []Driver, stratFactory p2p_discovery.BackoffFactory, opts ...p2p_discovery.BackoffDiscoveryOption) (Service, error)

type StreamWrapper added in v2.94.0

type StreamWrapper struct {
	network.Stream
	io.ReadWriter
}

func (*StreamWrapper) Read added in v2.94.0

func (s *StreamWrapper) Read(b []byte) (int, error)

Implementation of the io.ReadWriter interface

func (*StreamWrapper) Write added in v2.94.0

func (s *StreamWrapper) Write(b []byte) (int, error)

Implementation of the io.ReadWriter interface

type Unregisterer

type Unregisterer interface {
	Unregister(ctx context.Context, ns string) error
}
var NoopUnregisterer Unregisterer = &noopUnregisterer{}

Jump to

Keyboard shortcuts

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