network

Documentation

Overview

_       _

*__ _____ __ ___ ___ __ _| |_ ___ *\ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \ * \ V V / __/ (_| |\ V /| | (_| | || __/ * \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___| * * Copyright © 2016 - 2019 Weaviate. All rights reserved. * LICENSE: https://github.com/creativesoftwarefdn/weaviate/blob/develop/LICENSE.md * DESIGN & CONCEPT: Bob van Luijt (@bobvanluijt) * CONTACT: hello@creativesoftwarefdn.org

Index

• type Network
• type PeerUpdateCallback
• type SchemaGetter

Types

type Network

type Network interface {
	IsReady() bool
	GetStatus() string

	ListPeers() (peers.Peers, error)

	ProxyGetInstance(network_get.Params) (*models.GraphQLResponse, error)
	ProxyGetMetaInstance(network_getmeta.Params) (*models.GraphQLResponse, error)

	// UpdatePeers is Invoked by the Genesis server via an HTTP endpoint.
	UpdatePeers(newPeers peers.Peers) error

	// RegisterUpdatePeerCallback to be called after successful peer updates
	RegisterUpdatePeerCallback(callbackFn PeerUpdateCallback)

	// Register a SchemaGetter which can be called in each pinging
	// cycle to retrieve the current schema (hash)
	RegisterSchemaGetter(getter SchemaGetter)
}

Network is a Minimal abstraction over the network. This is the only API exposed to the rest of Weaviate.

type PeerUpdateCallback

type PeerUpdateCallback func(peers peers.Peers)

PeerUpdateCallback should be called by UpdatePeers after a successful peer update

type SchemaGetter

type SchemaGetter interface {
	Schema() (schema.Schema, error)
}

SchemaGetter must be provided to the Network, so the network has a means to retrieve the schema on each polling cycle. It does not care about whether a lock is necessary to retrieve the schema. If it is, then the provided implemtation must make sure that Schema() locks and unlocks.