webservice

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

type CollectionReverseRelations struct {
	Namespace  string
	Collection string
	Relations  []string
}

type Credentials struct {
	Username string
	Password string
}

type Environment struct {
	Username   string
	Account    func(account string) *tiedb.Collection
	Collection func(namespace, collection string) *tiedb.Collection
	Webservice *Webservice
}

type Reply struct {
	RequestName    string
	ReplyStructPtr interface{}
}

type ReplyStatus struct {
	Success bool
	Message string
	OrigKey string
}

type Request struct {
	Id             string
	ReplyStructPtr interface{}
}

type RequestInterface interface {
	GetId() string
	GetReplyStructPtr() interface{}
	Reply(environment *Environment) (Reply, error)
	// New returns a fresh, zero-valued instance of the same concrete request
	// type. RequestHandler unmarshals each incoming request into its own New()
	// instance so concurrent requests never share mutable state.
	New() RequestInterface
}

type StreamingRequestInterface interface {
	RequestInterface
	StreamReply(environment *Environment, w io.Writer) error
}

type Webservice struct {
	Config WebserviceConfig
	// contains filtered or unexported fields
}

type WebserviceConfig struct {
	ListenOn      string
	Insecure      bool
	CertFile      string
	KeyFile       string
	UserNamespace string
	DbPath        string

	// Auth resolves each request's role from its Basic Auth credentials and gates
	// read vs write operations. Access management is done by populating it from
	// the server's config file; it is read-only at runtime.
	Auth *auth.Store

	// ReverseRelations restricts which relations (value1) collections index in
	// reverse. Empty/nil indexes every relation (the original behavior). Set it
	// to just the relations queried in reverse to cut association memory roughly
	// in half on metadata-heavy stores. Acts as the default for collections with
	// no CollectionReverseRelations override.
	ReverseRelations []string

	// CollectionReverseRelations pins the reverse-relation set for specific
	// (namespace, collection) pairs, overriding ReverseRelations. A pair listed
	// here indexes exactly its relations in reverse; unlisted collections use the
	// default. Applied at collection load time, so changes require a restart.
	CollectionReverseRelations []CollectionReverseRelations

	// MaxConcurrentRequests caps how many requests execute simultaneously.
	// Zero or negative means unbounded. tiedb is concurrency-safe, so this is a
	// load-shedding knob, not a correctness requirement.
	MaxConcurrentRequests int
}