httpsync

Documentation

Index

• func SignedHeadSchema() schema.Type
• type Option
  • func WithAnnounceSenders(senders ...announce.Sender) Option
  • func WithExtraData(data []byte) Option
• type Publisher
  • func NewPublisher(address string, lsys ipld.LinkSystem, privKey ic.PrivKey, options ...Option) (*Publisher, error)
  • func NewPublisherForListener(listener net.Listener, handlerPath string, lsys ipld.LinkSystem, ...) (*Publisher, error)
  • func NewPublisherWithoutServer(address string, handlerPath string, lsys ipld.LinkSystem, privKey ic.PrivKey, ...) (*Publisher, error)
  • func (p *Publisher) Addrs() []multiaddr.Multiaddr
  • func (p *Publisher) AnnounceHead(ctx context.Context) error
  • func (p *Publisher) AnnounceHeadWithAddrs(ctx context.Context, addrs []multiaddr.Multiaddr) error
  • func (p *Publisher) Close() error
  • func (p *Publisher) ID() peer.ID
  • func (p *Publisher) Protocol() int
  • func (p *Publisher) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (p *Publisher) SetRoot(_ context.Context, c cid.Cid) error
  • func (p *Publisher) UpdateRoot(ctx context.Context, c cid.Cid) error
  • func (p *Publisher) UpdateRootWithAddrs(ctx context.Context, c cid.Cid, addrs []multiaddr.Multiaddr) error
• type Sync
  • func NewSync(lsys ipld.LinkSystem, client *http.Client, blockHook func(peer.ID, cid.Cid)) *Sync
  • func (s *Sync) Close()
  • func (s *Sync) NewSyncer(peerID peer.ID, peerAddrs []multiaddr.Multiaddr) (*Syncer, error)
• type Syncer
  • func (s *Syncer) GetHead(ctx context.Context) (cid.Cid, error)
  • func (s *Syncer) Sync(ctx context.Context, nextCid cid.Cid, sel ipld.Node) error

Functions

func SignedHeadSchema

func SignedHeadSchema() schema.Type

Types

type Option

type Option func(*config) error

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

func WithAnnounceSenders

func WithAnnounceSenders(senders ...announce.Sender) Option

WithAnnounceSenders sets announce.Senders to use for sending announcements.

func WithExtraData

func WithExtraData(data []byte) Option

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

type Publisher

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

Publisher is an HTTP publisher that announces the head of an advertisement chain to a set of configured senders.

func NewPublisher

func NewPublisher(address string, lsys ipld.LinkSystem, privKey ic.PrivKey, options ...Option) (*Publisher, error)

NewPublisher creates a new http publisher, listening on the specified address.

func NewPublisherForListener

func NewPublisherForListener(listener net.Listener, handlerPath string, lsys ipld.LinkSystem, privKey ic.PrivKey, options ...Option) (*Publisher, error)

NewPublisherForListener creates a new http publisher for an existing listener. When providing an existing listener, running the HTTP server is the caller's responsibility. ServeHTTP on the returned Publisher can be used to handle requests. handlerPath is the path to handle requests on, e.g. "ipni" for `/ipni/...` requests.

DEPRECATED: use NewPublisherWithoutServer(listener.Addr(), ...)

func NewPublisherWithoutServer

func NewPublisherWithoutServer(address string, handlerPath string, lsys ipld.LinkSystem, privKey ic.PrivKey, options ...Option) (*Publisher, error)

NewPublisherWithoutServer creates a new http publisher for an existing network address. When providing an existing network address, running the HTTP server is the caller's responsibility. ServeHTTP on the returned Publisher can be used to handle requests. handlerPath is the path to handle requests on, e.g. "ipni" for `/ipni/...` requests.

func (*Publisher) Addrs

func (p *Publisher) Addrs() []multiaddr.Multiaddr

Addrs returns the addresses, as []multiaddress, that the Publisher is listening on.

func (*Publisher) AnnounceHead

func (p *Publisher) AnnounceHead(ctx context.Context) error

AnnounceHead announces the head of the advertisement chain to the configured senders.

func (*Publisher) AnnounceHeadWithAddrs

func (p *Publisher) AnnounceHeadWithAddrs(ctx context.Context, addrs []multiaddr.Multiaddr) error

AnnounceHeadWithAddrs announces the head of the advertisement chain to the configured senders, with the provided addresses.

func (*Publisher) Close

func (p *Publisher) Close() error

Close closes the Publisher and all of its senders.

func (*Publisher) ID

func (p *Publisher) ID() peer.ID

ID returns the p2p peer ID of the Publisher.

func (*Publisher) Protocol

func (p *Publisher) Protocol() int

Protocol returns the multihash protocol ID of the transport used by the publisher.

func (*Publisher) ServeHTTP

func (p *Publisher) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements the http.Handler interface.

func (*Publisher) SetRoot

func (p *Publisher) SetRoot(_ context.Context, c cid.Cid) error

SetRoot sets the head of the advertisement chain.

func (*Publisher) UpdateRoot

func (p *Publisher) UpdateRoot(ctx context.Context, c cid.Cid) error

UpdateRoot updates the head of the advertisement chain and announces it to the configured senders.

func (*Publisher) UpdateRootWithAddrs

func (p *Publisher) UpdateRootWithAddrs(ctx context.Context, c cid.Cid, addrs []multiaddr.Multiaddr) error

UpdateRootWithAddrs updates the head of the advertisement chain and announces it to the configured senders, with the provided addresses.

type Sync

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

Sync provides sync functionality for use with all http syncs.

func NewSync

func NewSync(lsys ipld.LinkSystem, client *http.Client, blockHook func(peer.ID, cid.Cid)) *Sync

NewSync creates a new Sync.

func (*Sync) Close

func (s *Sync) Close()

func (*Sync) NewSyncer

func (s *Sync) NewSyncer(peerID peer.ID, peerAddrs []multiaddr.Multiaddr) (*Syncer, error)

NewSyncer creates a new Syncer to use for a single sync operation against a peer.

type Syncer

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

Syncer provides sync functionality for a single sync with a peer.

func (*Syncer) GetHead

func (s *Syncer) GetHead(ctx context.Context) (cid.Cid, error)

GetHead fetches the head of the peer's advertisement chain.

func (*Syncer) Sync

func (s *Syncer) Sync(ctx context.Context, nextCid cid.Cid, sel ipld.Node) error

Sync syncs the peer's advertisement chain or entries chain.