transport

type CSRFTokenResponse ¶

type CSRFTokenResponse struct {
	Token     string    `json:"token"`
	ExpiresAt time.Time `json:"expiresAt"`
}

CSRFTokenResponse is the wire shape for GET /api/dashboard/v1/csrf.

type CapabilitiesResponse ¶

type CapabilitiesResponse struct {
	ShellEnvelopes []string                `json:"shellEnvelopes"`
	Contributors   []ContributorCapability `json:"contributors"`
}

CapabilitiesResponse is the wire shape for GET /capabilities.

type ContributorCapability ¶

type ContributorCapability struct {
	Name      string             `json:"name"`
	Envelopes []string           `json:"envelopes"`
	Intents   []IntentCapability `json:"intents"`

	Version    string `json:"version,omitempty"`
	Configured bool   `json:"configured"`
	Message    string `json:"message,omitempty"`
}

ContributorCapability is one contributor's negotiable surface.

type ContributorStatus ¶ added in v1.11.1

type ContributorStatus struct {
	Version    string
	Configured bool
	Message    string
}

ContributorStatus is what the host reports about one contributor: the version a plugin's `requires` range is matched against, and whether the contributor has everything it needs to serve.

This mirrors dashboard.DashboardStatus, which is the interface extension authors implement. It is redeclared here because package dashboard already imports this package, so importing it back would be a cycle. The dashboard extension converts between the two at the wiring site.

type ContributorStatusFunc ¶ added in v1.11.1

type ContributorStatusFunc func(contributor string) (ContributorStatus, bool)

ContributorStatusFunc looks up a contributor's status by name. ok is false when nothing registered a status for that contributor, in which case the handler applies the permissive default (empty version, configured).

type ControlMessage ¶

type ControlMessage struct {
	StreamID       string                          `json:"streamID"`
	Op             string                          `json:"op"` // "subscribe" | "unsubscribe"
	SubscriptionID string                          `json:"subscriptionID"`
	Contributor    string                          `json:"contributor,omitempty"`
	Intent         string                          `json:"intent,omitempty"`
	Params         map[string]contract.ParamSource `json:"params,omitempty"`
}

ControlMessage is one client request on POST /stream/control.

type Dispatcher ¶

type Dispatcher interface {
	Dispatch(ctx context.Context, in contract.Request, p contract.Principal) (json.RawMessage, contract.ResponseMeta, error)
}

Dispatcher routes a fully-validated request to an intent implementation. Slice (c) provides the binding from intent name to actual handlers.

type HandlerOption ¶ added in v1.12.0

type HandlerOption func(*handler)

HandlerOption configures the handler returned by NewHandler.

func WithMaxBodyBytes(n int64) HandlerOption

type IntentCapability ¶

type IntentCapability struct {
	Name     string                `json:"name"`
	Versions []IntentVersionStatus `json:"versions"`
}

IntentCapability summarises one intent's available versions.

type IntentVersionStatus ¶

type IntentVersionStatus struct {
	N           int    `json:"n"`
	Status      string `json:"status"` // active | deprecated
	RemoveAfter string `json:"removeAfter,omitempty"`
}

IntentVersionStatus reports a single version + lifecycle status.

type NilDispatcher ¶

type NilDispatcher struct{}

NilDispatcher is the safe default when no real Dispatcher has been wired. Every dispatch returns a CodeUnavailable contract error so that callers see a clear, kind-agnostic failure instead of a nil panic.

func (NilDispatcher) Dispatch(_ context.Context, _ contract.Request, _ contract.Principal) (json.RawMessage, contract.ResponseMeta, error)

type StreamBroker ¶

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

StreamBroker manages active SSE connections + their subscriptions.

func NewStreamBroker(reg contract.Registry, wreg contract.WardenRegistry, source SubscriptionSource) *StreamBroker

func (b *StreamBroker) ConnectionCount() int

func (b *StreamBroker) ServeControl(w http.ResponseWriter, r *http.Request)

func (b *StreamBroker) ServeStream(w http.ResponseWriter, r *http.Request)

func (b *StreamBroker) SnapshotIDs() []string

type SubscriptionSource ¶

type SubscriptionSource interface {
	Subscribe(ctx context.Context, p contract.Principal, contributor string, intent contract.Intent, params map[string]contract.ParamSource) (<-chan contract.StreamEvent, func(), error)
}

SubscriptionSource is the upstream events feeder. Slice (c) implements one for each contributor's subscription intents.