api

type ChangeSet struct {
	Success []Field `json:"success"`
	Failure []Field `json:"failure"`
}

type Field string

type FieldScore struct {
	Field Field `json:"field"`
	Score int64 `json:"score"`
}

type FieldValueScore struct {
	Field Field  `json:"field"`
	Value []byte `json:"value"`
	Score int64  `json:"score"`
}

type Key string

type MembersInput struct {
	Members []FieldValueScore `json:"members"`
}

type Presence struct {
	Present  bool  `json:"present"`
	Inserted bool  `json:"inserted"`
	Score    int64 `json:"score"`
}

type Transport interface {
	TransportNetwork

	// Insert takes a key and value and stores with in the underlying store.
	// Returns ChangeSet of success and failure
	Insert(selectors.Key, []selectors.FieldValueScore) (selectors.ChangeSet, error)

	// Delete removes a value associated with the key.
	// Returns ChangeSet of success and failure
	Delete(selectors.Key, []selectors.FieldValueScore) (selectors.ChangeSet, error)

	// Select retrieves a field and score associated with the store.
	// Returns Field, Value and Score if the value found
	Select(selectors.Key, selectors.Field) (selectors.FieldValueScore, error)

	// Keys returns all the potential keys that are stored with in the store.
	Keys() ([]selectors.Key, error)

	// Size returns the number of members for the key are stored in the store.
	Size(selectors.Key) (int64, error)

	// Members returns the members associated for a key
	Members(selectors.Key) ([]selectors.Field, error)

	// Score returns the specific score for the field with in the key.
	Score(selectors.Key, selectors.Field) (selectors.Presence, error)
}

type TransportNetwork interface {

	// Hash returns the transport unique hash
	Hash() uint32

	// Host returns the transport underlying host
	Host() string
}

type TransportStrategy interface {

	// Apply applies a host to create a new api.Transport
	Apply(string) Transport
}