Documentation
¶
Index ¶
- func IsPluginRefreshCompatExecutor(executor coreauth.ProviderExecutor) bool
- func NewPluginRefreshCompatExecutor(inner coreauth.ProviderExecutor, host *Host, cfg *config.Config) coreauth.ProviderExecutor
- func PluginExtension(goos string) string
- func SupportPluginHeaderValue() string
- func UnwrapPluginRefreshCompatExecutor(executor coreauth.ProviderExecutor) (coreauth.ProviderExecutor, bool)
- func ValidatePluginID(id string) bool
- type AuthModelResult
- type Host
- func (h *Host) ApplyConfig(ctx context.Context, cfg *config.Config)
- func (h *Host) AuthDataToCoreAuth(data pluginapi.AuthData, path, fileName string) *coreauth.Auth
- func (h *Host) AuthProviderIdentifiers() []string
- func (h *Host) BuiltinProviders() []string
- func (h *Host) CompleteRequest(ctx context.Context, completion pluginapi.RequestCompletion)
- func (h *Host) CompleteRequestExcept(ctx context.Context, completion pluginapi.RequestCompletion, ...)
- func (h *Host) CountPluginExecutor(ctx context.Context, pluginID string, req coreexecutor.Request, ...) (coreexecutor.Response, error)
- func (h *Host) DescribeQuota(ctx context.Context, pluginID string) (pluginapi.QuotaDescribeResponse, bool, error)
- func (h *Host) ExecuteCommandLine(ctx context.Context, program string, args []string, configPath string, ...) (int, bool)
- func (h *Host) ExecutePluginExecutor(ctx context.Context, pluginID string, req coreexecutor.Request, ...) (coreexecutor.Response, error)
- func (h *Host) ExecutePluginExecutorStream(ctx context.Context, pluginID string, req coreexecutor.Request, ...) (*coreexecutor.StreamResult, error)
- func (h *Host) FetchQuota(ctx context.Context, req pluginapi.QuotaFetchRequest) (pluginapi.QuotaFetchResponse, bool, error)
- func (h *Host) FetchQuotaByPlugin(ctx context.Context, pluginID string, req pluginapi.QuotaFetchRequest) (pluginapi.QuotaFetchResponse, bool, error)
- func (h *Host) HasAuthModelProvider(provider string) bool
- func (h *Host) HasAuthProvider(provider string) bool
- func (h *Host) HasBuiltinProvider(provider string) bool
- func (h *Host) HasExecutorCandidateProvider(provider string) bool
- func (h *Host) HasModelRouters() bool
- func (h *Host) HasModelRoutersExcept(skipPluginID string) bool
- func (h *Host) HasQuotaProvider(provider string) bool
- func (h *Host) HasQuotaProviderContext(ctx context.Context, provider string) bool
- func (h *Host) HasQuotaProviderForPlugin(pluginID string) bool
- func (h *Host) HasRequestInterceptors() bool
- func (h *Host) HasScheduler() bool
- func (h *Host) HasStreamInterceptors() bool
- func (h *Host) HasTriggeredCommandLineFlags() bool
- func (h *Host) HasWebSocketResponseObservers() bool
- func (h *Host) InterceptRequestAfterAuth(ctx context.Context, req pluginapi.RequestInterceptRequest) pluginapi.RequestInterceptResponse
- func (h *Host) InterceptRequestAfterAuthExcept(ctx context.Context, req pluginapi.RequestInterceptRequest, ...) pluginapi.RequestInterceptResponse
- func (h *Host) InterceptRequestBeforeAuth(ctx context.Context, req pluginapi.RequestInterceptRequest) pluginapi.RequestInterceptResponse
- func (h *Host) InterceptRequestBeforeAuthExcept(ctx context.Context, req pluginapi.RequestInterceptRequest, ...) pluginapi.RequestInterceptResponse
- func (h *Host) InterceptResponse(ctx context.Context, req pluginapi.ResponseInterceptRequest) pluginapi.ResponseInterceptResponse
- func (h *Host) InterceptResponseExcept(ctx context.Context, req pluginapi.ResponseInterceptRequest, ...) pluginapi.ResponseInterceptResponse
- func (h *Host) InterceptStreamChunk(ctx context.Context, req pluginapi.StreamChunkInterceptRequest) pluginapi.StreamChunkInterceptResponse
- func (h *Host) InterceptStreamChunkExcept(ctx context.Context, req pluginapi.StreamChunkInterceptRequest, ...) pluginapi.StreamChunkInterceptResponse
- func (h *Host) ModelsForAuth(ctx context.Context, auth *coreauth.Auth) AuthModelResult
- func (h *Host) ModelsForProvider(provider string) []*registry.ModelInfo
- func (h *Host) NormalizeRequest(ctx context.Context, from, to sdktranslator.Format, model string, body []byte, ...) []byte
- func (h *Host) NormalizeResponseAfter(ctx context.Context, from, to sdktranslator.Format, model string, ...) []byte
- func (h *Host) NormalizeResponseBefore(ctx context.Context, from, to sdktranslator.Format, model string, ...) []byte
- func (h *Host) ObserveWebSocketResponseEvent(ctx context.Context, event pluginapi.WebSocketResponseEvent)
- func (h *Host) ObserveWebSocketResponseEventExcept(ctx context.Context, event pluginapi.WebSocketResponseEvent, ...)
- func (h *Host) OwnsExecutor(executor coreauth.ProviderExecutor) bool
- func (h *Host) ParseAuth(ctx context.Context, req pluginapi.AuthParseRequest) (*coreauth.Auth, bool, error)
- func (h *Host) ParseAuths(ctx context.Context, req pluginapi.AuthParseRequest) ([]*coreauth.Auth, bool, error)
- func (h *Host) PickAuth(ctx context.Context, req pluginapi.SchedulerPickRequest) (pluginapi.SchedulerPickResponse, bool, error)
- func (h *Host) PluginBusy(id string) bool
- func (h *Host) PluginExecutorRequestToFormat(pluginID string, req coreexecutor.Request, opts coreexecutor.Options) sdktranslator.Format
- func (h *Host) PluginLoaded(id string) bool
- func (h *Host) PluginRegistered(id string) bool
- func (h *Host) PollLogin(ctx context.Context, provider, state string, metadata ...map[string]any) (pluginapi.AuthLoginPollResponse, bool, error)
- func (h *Host) QuotaProviderIdentifiers() []string
- func (h *Host) QuotaProviderPluginIDs(ctx context.Context) map[string]string
- func (h *Host) QuotaProviders(ctx context.Context) []RegisteredQuotaProviderInfo
- func (h *Host) RefreshAuth(ctx context.Context, auth *coreauth.Auth) (refreshed *coreauth.Auth, handled bool, err error)
- func (h *Host) RegisterCommandLineFlags(ctx context.Context, flagSet *flag.FlagSet)
- func (h *Host) RegisterExecutors(manager executorManager, modelRegistry modelProviderRegistry)
- func (h *Host) RegisterFrontendAuthProviders()
- func (h *Host) RegisterManagementRoutes(ctx context.Context, reserved map[string]struct{})
- func (h *Host) RegisterModels(ctx context.Context, modelRegistry modelRegistry)
- func (h *Host) RegisterPluginForTest(id string, plugin pluginapi.Plugin)
- func (h *Host) RegisterUsagePlugins()
- func (h *Host) RegisteredPlugins() []RegisteredPluginInfo
- func (h *Host) ResetQuota(ctx context.Context, req pluginapi.QuotaResetRequest) (pluginapi.QuotaResetResponse, bool, error)
- func (h *Host) ResetQuotaByPlugin(ctx context.Context, pluginID string, req pluginapi.QuotaResetRequest) (pluginapi.QuotaResetResponse, bool, error)
- func (h *Host) RouteModel(ctx context.Context, req pluginapi.ModelRouteRequest) (pluginapi.ModelRouteResponse, bool)
- func (h *Host) RouteModelExcept(ctx context.Context, req pluginapi.ModelRouteRequest, skipPluginID string) (pluginapi.ModelRouteResponse, bool)
- func (h *Host) SchedulerWantsAcrossPriorities() bool
- func (h *Host) ServeManagementHTTP(w http.ResponseWriter, r *http.Request) bool
- func (h *Host) ServeResourceHTTP(w http.ResponseWriter, r *http.Request) bool
- func (h *Host) SetAuthManager(manager *coreauth.Manager)
- func (h *Host) SetModelExecutor(executor modelExecutor)
- func (h *Host) ShutdownAll()
- func (h *Host) ShutdownAllContext(ctx context.Context)
- func (h *Host) Snapshot() *Snapshot
- func (h *Host) StartLogin(ctx context.Context, provider string, baseURL string, ...) (pluginapi.AuthLoginStartResponse, bool, error)
- func (h *Host) StreamChunkPayloadIncludesHistory() bool
- func (h *Host) StreamChunkPayloadIncludesRequestBody() bool
- func (h *Host) TranslateRequest(ctx context.Context, from, to sdktranslator.Format, model string, body []byte, ...) ([]byte, bool)
- func (h *Host) TranslateResponse(ctx context.Context, from, to sdktranslator.Format, model string, ...) ([]byte, bool)
- func (h *Host) UnloadPlugin(id string) bool
- func (h *Host) UnloadPluginContext(ctx context.Context, id string) bool
- type PluginFileInfo
- type RegisteredPluginInfo
- type RegisteredPluginMenu
- type RegisteredQuotaProviderInfo
- type Snapshot
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsPluginRefreshCompatExecutor ¶
func IsPluginRefreshCompatExecutor(executor coreauth.ProviderExecutor) bool
IsPluginRefreshCompatExecutor reports whether executor is a plugin-refresh wrapper.
func NewPluginRefreshCompatExecutor ¶
func NewPluginRefreshCompatExecutor(inner coreauth.ProviderExecutor, host *Host, cfg *config.Config) coreauth.ProviderExecutor
NewPluginRefreshCompatExecutor wraps a native provider executor so Refresh is handled by the plugin AuthProvider for the same provider key.
func PluginExtension ¶
PluginExtension returns the dynamic library file extension used for goos.
func SupportPluginHeaderValue ¶
func SupportPluginHeaderValue() string
SupportPluginHeaderValue reports whether the current binary was built with CGO enabled.
func UnwrapPluginRefreshCompatExecutor ¶
func UnwrapPluginRefreshCompatExecutor(executor coreauth.ProviderExecutor) (coreauth.ProviderExecutor, bool)
UnwrapPluginRefreshCompatExecutor returns the inner native executor when executor is a plugin-refresh wrapper.
func ValidatePluginID ¶
ValidatePluginID reports whether id can be used as a plugin configuration key.
Types ¶
type AuthModelResult ¶
type Host ¶
type Host struct {
// contains filtered or unexported fields
}
func NewForTest ¶
func NewForTest(loader pluginLoader) *Host
func (*Host) AuthDataToCoreAuth ¶
func (*Host) AuthProviderIdentifiers ¶
func (*Host) BuiltinProviders ¶
BuiltinProviders returns built-in provider keys that currently have auth registered.
func (*Host) CompleteRequest ¶
func (h *Host) CompleteRequest(ctx context.Context, completion pluginapi.RequestCompletion)
CompleteRequest schedules terminal notifications without blocking response delivery.
func (*Host) CompleteRequestExcept ¶
func (h *Host) CompleteRequestExcept(ctx context.Context, completion pluginapi.RequestCompletion, skipPluginID string)
CompleteRequestExcept notifies lifecycle plugins except the plugin that initiated a nested host execution.
func (*Host) CountPluginExecutor ¶
func (h *Host) CountPluginExecutor(ctx context.Context, pluginID string, req coreexecutor.Request, opts coreexecutor.Options) (coreexecutor.Response, error)
CountPluginExecutor executes a count-tokens request with the named plugin executor without changing the requested model.
func (*Host) DescribeQuota ¶
func (h *Host) DescribeQuota(ctx context.Context, pluginID string) (pluginapi.QuotaDescribeResponse, bool, error)
DescribeQuota queries a plugin quota provider for metadata.
func (*Host) ExecuteCommandLine ¶
func (h *Host) ExecuteCommandLine(ctx context.Context, program string, args []string, configPath string, flagSet *flag.FlagSet) (int, bool)
ExecuteCommandLine runs all enabled plugins whose command-line flags were provided.
func (*Host) ExecutePluginExecutor ¶
func (h *Host) ExecutePluginExecutor(ctx context.Context, pluginID string, req coreexecutor.Request, opts coreexecutor.Options) (coreexecutor.Response, error)
ExecutePluginExecutor executes a request with the named plugin executor without changing the requested model.
func (*Host) ExecutePluginExecutorStream ¶
func (h *Host) ExecutePluginExecutorStream(ctx context.Context, pluginID string, req coreexecutor.Request, opts coreexecutor.Options) (*coreexecutor.StreamResult, error)
ExecutePluginExecutorStream executes a streaming request with the named plugin executor without changing the requested model.
func (*Host) FetchQuota ¶
func (h *Host) FetchQuota(ctx context.Context, req pluginapi.QuotaFetchRequest) (pluginapi.QuotaFetchResponse, bool, error)
FetchQuota queries quota information for a credential by provider or plugin ID.
func (*Host) FetchQuotaByPlugin ¶
func (h *Host) FetchQuotaByPlugin(ctx context.Context, pluginID string, req pluginapi.QuotaFetchRequest) (pluginapi.QuotaFetchResponse, bool, error)
FetchQuotaByPlugin queries quota information for a credential targeting a specific plugin.
func (*Host) HasAuthModelProvider ¶ added in v8.0.14
HasAuthModelProvider reports whether an active plugin declares per-auth model discovery for provider. It does not fetch models or refresh credentials.
func (*Host) HasAuthProvider ¶
func (*Host) HasBuiltinProvider ¶
HasBuiltinProvider reports whether a built-in provider currently has at least one registered auth record.
func (*Host) HasExecutorCandidateProvider ¶
func (*Host) HasModelRouters ¶
func (*Host) HasModelRoutersExcept ¶
func (*Host) HasQuotaProvider ¶
HasQuotaProvider reports whether a quota provider exists for the given provider key.
func (*Host) HasQuotaProviderContext ¶
HasQuotaProviderContext reports whether a quota provider exists with context cancellation support.
func (*Host) HasQuotaProviderForPlugin ¶
HasQuotaProviderForPlugin reports whether the given plugin ID provides quota capabilities.
func (*Host) HasRequestInterceptors ¶
func (*Host) HasScheduler ¶
func (*Host) HasStreamInterceptors ¶
func (*Host) HasTriggeredCommandLineFlags ¶
HasTriggeredCommandLineFlags reports whether any plugin-owned flag was provided.
func (*Host) HasWebSocketResponseObservers ¶
func (*Host) InterceptRequestAfterAuth ¶
func (h *Host) InterceptRequestAfterAuth(ctx context.Context, req pluginapi.RequestInterceptRequest) pluginapi.RequestInterceptResponse
func (*Host) InterceptRequestAfterAuthExcept ¶
func (h *Host) InterceptRequestAfterAuthExcept(ctx context.Context, req pluginapi.RequestInterceptRequest, skipPluginID string) pluginapi.RequestInterceptResponse
func (*Host) InterceptRequestBeforeAuth ¶
func (h *Host) InterceptRequestBeforeAuth(ctx context.Context, req pluginapi.RequestInterceptRequest) pluginapi.RequestInterceptResponse
func (*Host) InterceptRequestBeforeAuthExcept ¶
func (h *Host) InterceptRequestBeforeAuthExcept(ctx context.Context, req pluginapi.RequestInterceptRequest, skipPluginID string) pluginapi.RequestInterceptResponse
func (*Host) InterceptResponse ¶
func (h *Host) InterceptResponse(ctx context.Context, req pluginapi.ResponseInterceptRequest) pluginapi.ResponseInterceptResponse
func (*Host) InterceptResponseExcept ¶
func (h *Host) InterceptResponseExcept(ctx context.Context, req pluginapi.ResponseInterceptRequest, skipPluginID string) pluginapi.ResponseInterceptResponse
func (*Host) InterceptStreamChunk ¶
func (h *Host) InterceptStreamChunk(ctx context.Context, req pluginapi.StreamChunkInterceptRequest) pluginapi.StreamChunkInterceptResponse
func (*Host) InterceptStreamChunkExcept ¶
func (h *Host) InterceptStreamChunkExcept(ctx context.Context, req pluginapi.StreamChunkInterceptRequest, skipPluginID string) pluginapi.StreamChunkInterceptResponse
func (*Host) ModelsForAuth ¶
func (*Host) ModelsForProvider ¶
func (*Host) NormalizeRequest ¶
func (*Host) NormalizeResponseAfter ¶
func (*Host) NormalizeResponseBefore ¶
func (*Host) ObserveWebSocketResponseEvent ¶
func (h *Host) ObserveWebSocketResponseEvent(ctx context.Context, event pluginapi.WebSocketResponseEvent)
func (*Host) ObserveWebSocketResponseEventExcept ¶
func (*Host) OwnsExecutor ¶
func (h *Host) OwnsExecutor(executor coreauth.ProviderExecutor) bool
OwnsExecutor reports whether executor is an adapter managed by this host.
func (*Host) ParseAuths ¶
func (*Host) PickAuth ¶
func (h *Host) PickAuth(ctx context.Context, req pluginapi.SchedulerPickRequest) (pluginapi.SchedulerPickResponse, bool, error)
func (*Host) PluginBusy ¶
PluginBusy reports whether a plugin is active in the host runtime or being loaded.
func (*Host) PluginExecutorRequestToFormat ¶
func (h *Host) PluginExecutorRequestToFormat(pluginID string, req coreexecutor.Request, opts coreexecutor.Options) sdktranslator.Format
PluginExecutorRequestToFormat reports the executor input format selected for a direct plugin executor route.
func (*Host) PluginLoaded ¶
PluginLoaded reports whether a plugin is still active in the host runtime.
func (*Host) PluginRegistered ¶
PluginRegistered reports whether a plugin is active in the current runtime snapshot.
func (*Host) QuotaProviderIdentifiers ¶
QuotaProviderIdentifiers returns the list of unique quota provider identifiers.
func (*Host) QuotaProviderPluginIDs ¶ added in v8.0.25
QuotaProviderPluginIDs returns a point-in-time map from normalized provider keys to the ID of the quota plugin that quotaProviderRecord would select for that provider, preserving its two-pass precedence. This allows callers (e.g. ListAuthFiles) to resolve quota plugins with zero per-credential RPCs.
func (*Host) QuotaProviders ¶
func (h *Host) QuotaProviders(ctx context.Context) []RegisteredQuotaProviderInfo
QuotaProviders returns information about all active registered quota providers.
func (*Host) RefreshAuth ¶
func (*Host) RegisterCommandLineFlags ¶
RegisterCommandLineFlags exposes plugin-declared flags on the provided FlagSet.
func (*Host) RegisterExecutors ¶
func (h *Host) RegisterExecutors(manager executorManager, modelRegistry modelProviderRegistry)
func (*Host) RegisterFrontendAuthProviders ¶
func (h *Host) RegisterFrontendAuthProviders()
func (*Host) RegisterManagementRoutes ¶
RegisterManagementRoutes rebuilds the plugin-owned Management API and resource route tables.
func (*Host) RegisterModels ¶
RegisterModels collects static catalogs for executor and per-auth registration. Catalog-only plugins must not advertise availability independently of credentials.
func (*Host) RegisterPluginForTest ¶
RegisterPluginForTest registers a plugin directly on the host for testing.
func (*Host) RegisterUsagePlugins ¶
func (h *Host) RegisterUsagePlugins()
func (*Host) RegisteredPlugins ¶
func (h *Host) RegisteredPlugins() []RegisteredPluginInfo
RegisteredPlugins returns a stable copy of plugin metadata in the current runtime snapshot.
func (*Host) ResetQuota ¶
func (h *Host) ResetQuota(ctx context.Context, req pluginapi.QuotaResetRequest) (pluginapi.QuotaResetResponse, bool, error)
ResetQuota resets quota or usage for a credential if supported.
func (*Host) ResetQuotaByPlugin ¶
func (h *Host) ResetQuotaByPlugin(ctx context.Context, pluginID string, req pluginapi.QuotaResetRequest) (pluginapi.QuotaResetResponse, bool, error)
ResetQuotaByPlugin resets quota or usage for a credential targeting a specific plugin.
func (*Host) RouteModel ¶
func (h *Host) RouteModel(ctx context.Context, req pluginapi.ModelRouteRequest) (pluginapi.ModelRouteResponse, bool)
func (*Host) RouteModelExcept ¶
func (h *Host) RouteModelExcept(ctx context.Context, req pluginapi.ModelRouteRequest, skipPluginID string) (pluginapi.ModelRouteResponse, bool)
func (*Host) SchedulerWantsAcrossPriorities ¶
func (*Host) ServeManagementHTTP ¶
ServeManagementHTTP dispatches an authenticated Management API request to a plugin route.
func (*Host) ServeResourceHTTP ¶
ServeResourceHTTP dispatches an unauthenticated browser-navigable resource request to a plugin route.
func (*Host) SetAuthManager ¶
func (*Host) SetModelExecutor ¶
func (h *Host) SetModelExecutor(executor modelExecutor)
func (*Host) ShutdownAll ¶
func (h *Host) ShutdownAll()
ShutdownAll removes active plugin capabilities and detaches all plugins. Plugin images stay mapped for the lifetime of the process.
func (*Host) ShutdownAllContext ¶
ShutdownAllContext detaches all plugin runtime state without waiting beyond ctx for active plugin calls to complete.
func (*Host) StartLogin ¶
func (*Host) StreamChunkPayloadIncludesHistory ¶
StreamChunkPayloadIncludesHistory reports whether any active stream chunk interceptor still requires HistoryChunks on payload chunks (schema_version < SchemaVersionStreamChunkOmitHistory).
func (*Host) StreamChunkPayloadIncludesRequestBody ¶
StreamChunkPayloadIncludesRequestBody reports whether any active stream chunk interceptor still requires OriginalRequest/RequestBody on payload chunks (schema_version < SchemaVersionStreamChunkOmitRequestBody).
func (*Host) TranslateRequest ¶
func (*Host) TranslateResponse ¶
func (*Host) UnloadPlugin ¶
UnloadPlugin removes one plugin from the active runtime. The plugin image itself stays mapped for the lifetime of the process.
type PluginFileInfo ¶
PluginFileInfo describes a plugin binary selected by the host discovery rules.
func DiscoverPluginFiles ¶
func DiscoverPluginFiles(root string, desiredVersions ...map[string]string) ([]PluginFileInfo, error)
DiscoverPluginFiles returns plugin binaries selected by the current host discovery rules.
type RegisteredPluginInfo ¶
type RegisteredPluginInfo struct {
ID string
Priority int
Metadata pluginapi.Metadata
SupportsOAuth bool
OAuthProvider string
SupportsQuota bool
QuotaProvider string
Menus []RegisteredPluginMenu
}
RegisteredPluginInfo describes a plugin that is active in the current runtime snapshot.
type RegisteredPluginMenu ¶
RegisteredPluginMenu describes a plugin-owned resource menu entry.
Source Files
¶
- abi.go
- adapters.go
- adapters_auth.go
- adapters_executors.go
- adapters_interceptors.go
- adapters_usage_translation.go
- affinity_callbacks.go
- auth_callbacks.go
- auth_provider.go
- callback_contexts.go
- client_guard.go
- command_line.go
- config.go
- executor_route.go
- host.go
- host_callbacks.go
- host_callbacks_unix.go
- host_model_stream_callbacks.go
- http_bridge.go
- http_operation_bridge.go
- http_stream_bridge.go
- loader_unix.go
- logging.go
- management.go
- model_router.go
- model_stream_bridge.go
- platform.go
- plugin_refresh_compat_executor.go
- quota_provider.go
- routing_callbacks.go
- rpc_client.go
- rpc_client_stream.go
- rpc_schema.go
- scheduler.go
- shadow.go
- shadow_unix.go
- snapshot.go
- stream_bridge.go
- support.go
- support_cgo.go