peer

type Collection struct {
	// Dependencies.
	Behaviour   Service
	Information Service
	// contains filtered or unexported fields
}

type CollectionConfig struct {
	// Dependencies.
	BehaviourService   Service
	InformationService Service
}

type Config struct {
	// Settings.
	Created time.Time
	ID      string
	Kind    string
	Value   string
}

type Peer interface {
	// Created returns the creation time of the current peer.
	Created() time.Time
	// Deprecated returns the deprecation state of the current peer. See
	// Service.Mutate and Service.Search for more information.
	Deprecated() bool
	// ID returns the ID of the current peer. This ID is used to store the peer
	// under the hood of the peer service. In case of a behaviour peer, this ID is
	// also referenced as the behaviour ID, an ID for the specific implementation
	// of a CLG. In case of a information peer, this ID is also referenced as the
	// information ID, an ID for some specific, resusable feature.
	ID() string
	json.Marshaler
	json.Unmarshaler
	// Kind returns the kind of the peer. This must be either KindBehaviour or
	// KindInformation.
	Kind() string
	// SetDeprecated sets the deprecated field of the current peer to the given
	// value.
	SetDeprecated(deprecated bool)
	// SetValue sets the value field of the current peer to the given value.
	SetValue(value string)
	// Value returns the actual peer value. In case of a behaviour peer, this
	// value is also referenced as behaviour name, or CLG name. In case of an
	// information peer, this value is also referenced as some specific, resusable
	// feature.
	Value() string
}

type Service interface {
	// Boot initializes and starts the whole service like booting a machine. The
	// call to Boot blocks until the service is completely initialized, so you
	// might want to call it in a separate goroutine.
	Boot()
	// Create creates a new peer for the given peer value. Additionally Create
	// ensures that all necessary references and connections related to a new peer
	// are constructued.
	Create(ctx context.Context, peerAValue string) (Peer, error)
	// Delete removes the peer identified by the given peer value. Additionally
	// Delete ensures that all necessary references and connections related to the
	// identified peer are cleaned up.
	Delete(ctx context.Context, peerAValue string) error
	// Exists checks whether the peer identified by the given peer value exists.
	// Exists returns also true in case the peer being looked up is deprecated.
	Exists(ctx context.Context, peerAValue string) (bool, error)
	// Kind returns the kind of the current service implementation. This must be
	// either KindBehaviour or KindInformation.
	Kind() string
	// Mutate implements an evolutional primitive. The purpose of Mutate is to
	// provide functionality of improving peers and their connections within the
	// connection space of the neural network.
	//
	// Mutate looks up the peer identified by the first given peer value. This
	// peer is the target intended to be mutated. The mutation process "splits"
	// the target peer into two. Therefore two new peers are created, having the
	// same kind as the target peer. The two new peers get the second and third
	// provided peer values applied. The target peer is marked as deprecated. The
	// target peer furthermore only acts as proxy to the two new peers.
	// Connections related to the three peers described here are updated
	// accordingly to guaranty the neural network operable.
	//
	// Mutate may never be used in combination with peers of kind KindBehaviour.
	Mutate(ctx context.Context, peerAValue, newPeerAValue, newPeerBValue string) (Peer, Peer, error)
	// Position looks up the position of the peer identified by the given peer
	// value. The peer returned by Position is always a position peer. The call to
	// Peer.Value of a position peer must always return the position of the
	// initially referenced peer. This behaviour applies to all kind of peers,
	// whether they are of the kind KindBehaviour or KindInformation.
	Position(ctx context.Context, peerAValue string) (Peer, error)
	// Random searches for a random peer of the connection space and returns it.
	// The returned peer is never deprecated.
	Random(ctx context.Context) (Peer, error)
	// Search looks up the peer identified by the given peer value. Therefore the
	// given peer value is used to resolve the actual peer ID. The mapping between
	// peer values and peer IDs is managemed by the index service. Note that
	// peers, regardless of their kind, are always stored and looked up by their
	// ID.
	//
	// Search may return an deprecate error in case the given peer value
	// references a deprecated peer. In that case, clients using the management
	// primitives of the peer service are adviced to handle the deprecate error by
	// reevaluating the connections of the associated peers using the connection
	// service accordingly.
	Search(ctx context.Context, peerAValue string) (Peer, error)
	// SearchByID is like Search, with the exception that it uses a peer's ID for
	// the initial index lookup.
	SearchByID(ctx context.Context, peerAID string) (Peer, error)
	// SearchPath looks up the chain of peers associated with the given list of
	// peer values, if any. Imagine having the following information peer values.
	//
	//     "the" " " "dog"
	//
	// Here the information peer values form a chain in which the direct
	// neighbours are connected.
	SearchPath(ctx context.Context, peerValues ...string) ([]Peer, error)
	// Shutdown ends all processes of the service like shutting down a machine.
	// The call to Shutdown blocks until the service is completely shut down, so
	// you might want to call it in a separate goroutine.
	Shutdown()
}

type ServiceConfig struct {
	// Dependencies.
	ConnectionService connection.Service
	IDService         id.Service
	IndexService      index.Service
	PositionService   position.Service
	StorageCollection *storage.Collection
	WorkerService     worker.Service

	// Settings.
	Kind string
}