carmirror

package

v0.0.0-...-9be8bb9 Latest Latest Go to latest Published: Jun 14, 2023 License: Apache-2.0 Imports: 22 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fission-codes/kubo-car-mirror

Documentation ¶

Index ¶

Constants
func NewLocalNodeGetter(api kubo.CoreAPI) (ipld.NodeGetter, error)
func WriteError(w http.ResponseWriter, err error)
func WriteSuccess(w http.ResponseWriter)
func XX3HashBlockId(id cmipld.Cid, seed uint64) uint64
type CancelParams
type CarMirror
- func New(capi coreiface.CoreAPI, blockStore *KuboStore, opts ...func(cfg *Config)) (*CarMirror, error)
type Config
- func (cfg *Config) Validate() error
type KuboStore
- func NewKuboStore(core kubo.CoreAPI) *KuboStore
type LsParams
type LsResponse
type PullParams
type PushParams
type StatsParams

Constants ¶

View Source

const HASH_FUNCTION = 3

View Source

const Version = "0.1.0"

Variables ¶

This section is empty.

Functions ¶

func NewLocalNodeGetter ¶

func NewLocalNodeGetter(api kubo.CoreAPI) (ipld.NodeGetter, error)

NewLocalNodeGetter creates a local (no fetch) NodeGetter from a CoreAPI.

func WriteError ¶

func WriteError(w http.ResponseWriter, err error)

func WriteSuccess ¶

func WriteSuccess(w http.ResponseWriter)

func XX3HashBlockId ¶

func XX3HashBlockId(id cmipld.Cid, seed uint64) uint64

Types ¶

type CancelParams ¶

type CancelParams struct {
	Session string
}

type CarMirror ¶

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

func New ¶

func New(capi coreiface.CoreAPI, blockStore *KuboStore, opts ...func(cfg *Config)) (*CarMirror, error)

New creates a local CAR Mirror service.

func (*CarMirror) CancelHandler ¶

func (cm *CarMirror) CancelHandler() http.HandlerFunc

func (*CarMirror) LsHandler ¶

func (cm *CarMirror) LsHandler() http.HandlerFunc

func (*CarMirror) NewPullSessionHandler ¶

func (cm *CarMirror) NewPullSessionHandler() http.HandlerFunc

func (*CarMirror) NewPushSessionHandler ¶

func (cm *CarMirror) NewPushSessionHandler() http.HandlerFunc

func (*CarMirror) StartRemote ¶

func (cm *CarMirror) StartRemote(ctx context.Context) error

func (*CarMirror) StatsHandler ¶

func (cm *CarMirror) StatsHandler() http.HandlerFunc

type Config ¶

type Config struct {
	HTTPRemoteAddr       string
	MaxBlocksPerRound    uint32
	MaxBlocksPerColdCall uint32
}

Config encapsulates CAR Mirror configuration

func (*Config) Validate ¶

func (cfg *Config) Validate() error

Validate confirms the configuration is valid

type KuboStore ¶

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

func NewKuboStore ¶

func NewKuboStore(core kubo.CoreAPI) *KuboStore

func (*KuboStore) Add ¶

func (ks *KuboStore) Add(ctx context.Context, block cm.RawBlock[cmipld.Cid]) (cm.Block[cmipld.Cid], error)

func (*KuboStore) AddMany ¶

func (ks *KuboStore) AddMany(ctx context.Context, rawBlocks []cm.RawBlock[cmipld.Cid]) ([]cm.Block[cmipld.Cid], error)

func (*KuboStore) All ¶

func (ks *KuboStore) All(ctx context.Context) (<-chan cmipld.Cid, error)

There doesn't seem to be a clear way to list all the CIDs since the underlying blockstore is not exposed in the core Kubo API. This method will therefore list the cids of all pinned objects

func (*KuboStore) Get ¶

func (ks *KuboStore) Get(ctx context.Context, cid cmipld.Cid) (cm.Block[cmipld.Cid], error)

func (*KuboStore) Has ¶

func (ks *KuboStore) Has(ctx context.Context, cid cmipld.Cid) (bool, error)

type LsParams ¶

type LsParams struct {
}

TODO: Any params?

type LsResponse ¶

type LsResponse struct {
	SessionId   string
	SessionInfo string
}

type PullParams ¶

type PullParams struct {
	Cid        string
	Addr       string
	Stream     bool
	Background bool
}

type PushParams ¶

type PushParams struct {
	Cid        string
	Addr       string
	Diff       string
	Stream     bool
	Background bool
}

type StatsParams ¶

type StatsParams struct {
	Session string
}

Source Files ¶

View all Source files

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