exchange

Documentation

Index

• Constants
• type Exchange
• type FxExchange
  • func NewFxExchange(h host.Host, ls ipld.LinkSystem, o ...Option) (*FxExchange, error)
  • func (e *FxExchange) GetAuth(ctx context.Context) (peer.ID, error)
  • func (e *FxExchange) Pull(ctx context.Context, from peer.ID, l ipld.Link) error
  • func (e *FxExchange) Push(ctx context.Context, to peer.ID, l ipld.Link) error
  • func (e *FxExchange) SetAuth(ctx context.Context, on peer.ID, subject peer.ID, allow bool) error
  • func (e *FxExchange) Shutdown(ctx context.Context) error
  • func (e *FxExchange) Start(ctx context.Context) error
• type NoopExchange
  • func (n NoopExchange) Pull(_ context.Context, from peer.ID, l ipld.Link) error
  • func (n NoopExchange) Push(_ context.Context, to peer.ID, l ipld.Link) error
  • func (n NoopExchange) SetAuth(_ context.Context, on peer.ID, subject peer.ID, allow bool) error
  • func (n NoopExchange) Shutdown(context.Context) error
  • func (n NoopExchange) Start(context.Context) error
• type Option
  • func WithAllowTransientConnection(t bool) Option
  • func WithAuthorizer(a peer.ID) Option
  • func WithIpniProviderEngineOptions(e ...engine.Option) Option
  • func WithIpniPublishChanBuffer(s int) Option
  • func WithIpniPublishDisabled(d bool) Option
  • func WithIpniPublishInterval(t time.Duration) Option
  • func WithIpniPublishMaxBatchSize(s int) Option

Constants

const (
	FxExchangeProtocolID = "/fx.land/exchange/0.0.1"
)

Types

type Exchange

type Exchange interface {
	Start(context.Context) error
	Push(context.Context, peer.ID, ipld.Link) error
	Pull(context.Context, peer.ID, ipld.Link) error
	SetAuth(context.Context, peer.ID, peer.ID, bool) error
	Shutdown(context.Context) error
}

type FxExchange

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

func NewFxExchange

func NewFxExchange(h host.Host, ls ipld.LinkSystem, o ...Option) (*FxExchange, error)

func (*FxExchange) GetAuth

func (e *FxExchange) GetAuth(ctx context.Context) (peer.ID, error)

func (*FxExchange) Pull

func (e *FxExchange) Pull(ctx context.Context, from peer.ID, l ipld.Link) error

func (*FxExchange) Push

func (e *FxExchange) Push(ctx context.Context, to peer.ID, l ipld.Link) error

func (*FxExchange) SetAuth

func (e *FxExchange) SetAuth(ctx context.Context, on peer.ID, subject peer.ID, allow bool) error

func (*FxExchange) Shutdown

func (e *FxExchange) Shutdown(ctx context.Context) error

func (*FxExchange) Start

func (e *FxExchange) Start(ctx context.Context) error

type NoopExchange

type NoopExchange struct{}

func (NoopExchange) Pull

func (n NoopExchange) Pull(_ context.Context, from peer.ID, l ipld.Link) error

func (NoopExchange) Push

func (n NoopExchange) Push(_ context.Context, to peer.ID, l ipld.Link) error

func (NoopExchange) SetAuth

func (n NoopExchange) SetAuth(_ context.Context, on peer.ID, subject peer.ID, allow bool) error

func (NoopExchange) Shutdown

func (n NoopExchange) Shutdown(context.Context) error

func (NoopExchange) Start

func (n NoopExchange) Start(context.Context) error

type Option

type Option func(*options) error

func WithAllowTransientConnection

func WithAllowTransientConnection(t bool) Option

func WithAuthorizer

func WithAuthorizer(a peer.ID) Option

WithAuthorizer sets the peer ID that has permission to configure DAG exchange authorization. Defaults to authorization disabled.

func WithIpniProviderEngineOptions

func WithIpniProviderEngineOptions(e ...engine.Option) Option

func WithIpniPublishChanBuffer

func WithIpniPublishChanBuffer(s int) Option

func WithIpniPublishDisabled

func WithIpniPublishDisabled(d bool) Option

func WithIpniPublishInterval

func WithIpniPublishInterval(t time.Duration) Option

func WithIpniPublishMaxBatchSize

func WithIpniPublishMaxBatchSize(s int) Option