v1connect

package
v0.4.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 10, 2024 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	// InternalServiceAddMdnsHostProcedure is the fully-qualified name of the InternalService's
	// AddMdnsHost RPC.
	InternalServiceAddMdnsHostProcedure = "/platform.server.v1.InternalService/AddMdnsHost"
	// InternalServiceRemoveMdnsHostProcedure is the fully-qualified name of the InternalService's
	// RemoveMdnsHost RPC.
	InternalServiceRemoveMdnsHostProcedure = "/platform.server.v1.InternalService/RemoveMdnsHost"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source 
const (
	// WebServiceShutdownHostProcedure is the fully-qualified name of the WebService's ShutdownHost RPC.
	WebServiceShutdownHostProcedure = "/platform.server.v1.WebService/ShutdownHost"
	// WebServiceRestartHostProcedure is the fully-qualified name of the WebService's RestartHost RPC.
	WebServiceRestartHostProcedure = "/platform.server.v1.WebService/RestartHost"
	// WebServiceInstallAppProcedure is the fully-qualified name of the WebService's InstallApp RPC.
	WebServiceInstallAppProcedure = "/platform.server.v1.WebService/InstallApp"
	// WebServiceDeleteAppProcedure is the fully-qualified name of the WebService's DeleteApp RPC.
	WebServiceDeleteAppProcedure = "/platform.server.v1.WebService/DeleteApp"
	// WebServiceUpdateAppProcedure is the fully-qualified name of the WebService's UpdateApp RPC.
	WebServiceUpdateAppProcedure = "/platform.server.v1.WebService/UpdateApp"
	// WebServiceCheckForSystemUpdatesProcedure is the fully-qualified name of the WebService's
	// CheckForSystemUpdates RPC.
	WebServiceCheckForSystemUpdatesProcedure = "/platform.server.v1.WebService/CheckForSystemUpdates"
	// WebServiceCheckForContainerUpdatesProcedure is the fully-qualified name of the WebService's
	// CheckForContainerUpdates RPC.
	WebServiceCheckForContainerUpdatesProcedure = "/platform.server.v1.WebService/CheckForContainerUpdates"
	// WebServiceChangeDaemonVersionProcedure is the fully-qualified name of the WebService's
	// ChangeDaemonVersion RPC.
	WebServiceChangeDaemonVersionProcedure = "/platform.server.v1.WebService/ChangeDaemonVersion"
	// WebServiceInstallOSUpdateProcedure is the fully-qualified name of the WebService's
	// InstallOSUpdate RPC.
	WebServiceInstallOSUpdateProcedure = "/platform.server.v1.WebService/InstallOSUpdate"
	// WebServiceSetSystemImageProcedure is the fully-qualified name of the WebService's SetSystemImage
	// RPC.
	WebServiceSetSystemImageProcedure = "/platform.server.v1.WebService/SetSystemImage"
	// WebServiceAppsHealthCheckProcedure is the fully-qualified name of the WebService's
	// AppsHealthCheck RPC.
	WebServiceAppsHealthCheckProcedure = "/platform.server.v1.WebService/AppsHealthCheck"
	// WebServiceGetSystemStatsProcedure is the fully-qualified name of the WebService's GetSystemStats
	// RPC.
	WebServiceGetSystemStatsProcedure = "/platform.server.v1.WebService/GetSystemStats"
	// WebServiceIsDeviceSetupProcedure is the fully-qualified name of the WebService's IsDeviceSetup
	// RPC.
	WebServiceIsDeviceSetupProcedure = "/platform.server.v1.WebService/IsDeviceSetup"
	// WebServiceInitializeDeviceProcedure is the fully-qualified name of the WebService's
	// InitializeDevice RPC.
	WebServiceInitializeDeviceProcedure = "/platform.server.v1.WebService/InitializeDevice"
	// WebServiceLoginProcedure is the fully-qualified name of the WebService's Login RPC.
	WebServiceLoginProcedure = "/platform.server.v1.WebService/Login"
	// WebServiceGetAppsInStoreProcedure is the fully-qualified name of the WebService's GetAppsInStore
	// RPC.
	WebServiceGetAppsInStoreProcedure = "/platform.server.v1.WebService/GetAppsInStore"
	// WebServiceGetDeviceSettingsProcedure is the fully-qualified name of the WebService's
	// GetDeviceSettings RPC.
	WebServiceGetDeviceSettingsProcedure = "/platform.server.v1.WebService/GetDeviceSettings"
	// WebServiceSubscribeProcedure is the fully-qualified name of the WebService's Subscribe RPC.
	WebServiceSubscribeProcedure = "/platform.server.v1.WebService/Subscribe"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source 
const (
	// InternalServiceName is the fully-qualified name of the InternalService service.
	InternalServiceName = "platform.server.v1.InternalService"
)
View Source 
const (
	// WebServiceName is the fully-qualified name of the WebService service.
	WebServiceName = "platform.server.v1.WebService"
)

Variables

This section is empty.

Functions

func NewInternalServiceHandler added in v0.4.9 

func NewInternalServiceHandler(svc InternalServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewInternalServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

func NewWebServiceHandler 

func NewWebServiceHandler(svc WebServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewWebServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type InternalServiceClient added in v0.4.9 

type InternalServiceClient interface {
	AddMdnsHost(context.Context, *connect.Request[v1.AddMdnsHostRequest]) (*connect.Response[v1.AddMdnsHostResponse], error)
	RemoveMdnsHost(context.Context, *connect.Request[v1.RemoveMdnsHostRequest]) (*connect.Response[v1.RemoveMdnsHostResponse], error)
}

InternalServiceClient is a client for the platform.server.v1.InternalService service.

func NewInternalServiceClient added in v0.4.9 

func NewInternalServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) InternalServiceClient

NewInternalServiceClient constructs a client for the platform.server.v1.InternalService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type InternalServiceHandler added in v0.4.9 

type InternalServiceHandler interface {
	AddMdnsHost(context.Context, *connect.Request[v1.AddMdnsHostRequest]) (*connect.Response[v1.AddMdnsHostResponse], error)
	RemoveMdnsHost(context.Context, *connect.Request[v1.RemoveMdnsHostRequest]) (*connect.Response[v1.RemoveMdnsHostResponse], error)
}

InternalServiceHandler is an implementation of the platform.server.v1.InternalService service.

type UnimplementedInternalServiceHandler added in v0.4.9 

type UnimplementedInternalServiceHandler struct{}

UnimplementedInternalServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedInternalServiceHandler) AddMdnsHost added in v0.4.9 

func (UnimplementedInternalServiceHandler) AddMdnsHost(context.Context, *connect.Request[v1.AddMdnsHostRequest]) (*connect.Response[v1.AddMdnsHostResponse], error)

func (UnimplementedInternalServiceHandler) RemoveMdnsHost added in v0.4.9 

func (UnimplementedInternalServiceHandler) RemoveMdnsHost(context.Context, *connect.Request[v1.RemoveMdnsHostRequest]) (*connect.Response[v1.RemoveMdnsHostResponse], error)

type UnimplementedWebServiceHandler 

type UnimplementedWebServiceHandler struct{}

UnimplementedWebServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedWebServiceHandler) AppsHealthCheck added in v0.3.7 

func (UnimplementedWebServiceHandler) AppsHealthCheck(context.Context, *connect.Request[v1.AppsHealthCheckRequest]) (*connect.Response[v1.AppsHealthCheckResponse], error)

func (UnimplementedWebServiceHandler) ChangeDaemonVersion added in v0.3.5 

func (UnimplementedWebServiceHandler) ChangeDaemonVersion(context.Context, *connect.Request[v1.ChangeDaemonVersionRequest]) (*connect.Response[v1.ChangeDaemonVersionResponse], error)

func (UnimplementedWebServiceHandler) CheckForContainerUpdates added in v0.3.4 

func (UnimplementedWebServiceHandler) CheckForContainerUpdates(context.Context, *connect.Request[v1.CheckForContainerUpdatesRequest]) (*connect.Response[v1.CheckForContainerUpdatesResponse], error)

func (UnimplementedWebServiceHandler) CheckForSystemUpdates added in v0.3.2 

func (UnimplementedWebServiceHandler) CheckForSystemUpdates(context.Context, *connect.Request[v1.CheckForSystemUpdatesRequest]) (*connect.Response[v1.CheckForSystemUpdatesResponse], error)

func (UnimplementedWebServiceHandler) DeleteApp added in v0.3.0 

func (UnimplementedWebServiceHandler) DeleteApp(context.Context, *connect.Request[v1.DeleteAppRequest]) (*connect.Response[v1.DeleteAppResponse], error)

func (UnimplementedWebServiceHandler) GetAppsInStore added in v0.4.0 

func (UnimplementedWebServiceHandler) GetAppsInStore(context.Context, *connect.Request[v1.GetAppsInStoreRequest]) (*connect.Response[v1.GetAppsInStoreResponse], error)

func (UnimplementedWebServiceHandler) GetDeviceSettings added in v0.4.0 

func (UnimplementedWebServiceHandler) GetDeviceSettings(context.Context, *connect.Request[v1.GetDeviceSettingsRequest]) (*connect.Response[v1.GetDeviceSettingsResponse], error)

func (UnimplementedWebServiceHandler) GetSystemStats added in v0.3.8 

func (UnimplementedWebServiceHandler) GetSystemStats(context.Context, *connect.Request[v1.GetSystemStatsRequest]) (*connect.Response[v1.GetSystemStatsResponse], error)

func (UnimplementedWebServiceHandler) InitializeDevice added in v0.4.0 

func (UnimplementedWebServiceHandler) InitializeDevice(context.Context, *connect.Request[v1.InitializeDeviceRequest]) (*connect.Response[v1.InitializeDeviceResponse], error)

func (UnimplementedWebServiceHandler) InstallApp added in v0.3.0 

func (UnimplementedWebServiceHandler) InstallApp(context.Context, *connect.Request[v1.InstallAppRequest]) (*connect.Response[v1.InstallAppResponse], error)

func (UnimplementedWebServiceHandler) InstallOSUpdate added in v0.3.5 

func (UnimplementedWebServiceHandler) InstallOSUpdate(context.Context, *connect.Request[v1.InstallOSUpdateRequest]) (*connect.Response[v1.InstallOSUpdateResponse], error)

func (UnimplementedWebServiceHandler) IsDeviceSetup added in v0.4.0 

func (UnimplementedWebServiceHandler) IsDeviceSetup(context.Context, *connect.Request[v1.IsDeviceSetupRequest]) (*connect.Response[v1.IsDeviceSetupResponse], error)

func (UnimplementedWebServiceHandler) Login added in v0.4.0 

func (UnimplementedWebServiceHandler) Login(context.Context, *connect.Request[v1.LoginRequest]) (*connect.Response[v1.LoginResponse], error)

func (UnimplementedWebServiceHandler) RestartHost 

func (UnimplementedWebServiceHandler) RestartHost(context.Context, *connect.Request[v1.RestartHostRequest]) (*connect.Response[v1.RestartHostResponse], error)

func (UnimplementedWebServiceHandler) SetSystemImage added in v0.3.6 

func (UnimplementedWebServiceHandler) SetSystemImage(context.Context, *connect.Request[v1.SetSystemImageRequest]) (*connect.Response[v1.SetSystemImageResponse], error)

func (UnimplementedWebServiceHandler) ShutdownHost 

func (UnimplementedWebServiceHandler) ShutdownHost(context.Context, *connect.Request[v1.ShutdownHostRequest]) (*connect.Response[v1.ShutdownHostResponse], error)

func (UnimplementedWebServiceHandler) Subscribe added in v0.4.10 

func (UnimplementedWebServiceHandler) Subscribe(context.Context, *connect.Request[v1.SubscribeRequest], *connect.ServerStream[v1.ServerEvent]) error

func (UnimplementedWebServiceHandler) UpdateApp added in v0.3.0 

func (UnimplementedWebServiceHandler) UpdateApp(context.Context, *connect.Request[v1.UpdateAppRequest]) (*connect.Response[v1.UpdateAppResponse], error)

type WebServiceClient 

type WebServiceClient interface {
	// Shutdown the host machine running Home Cloud
	ShutdownHost(context.Context, *connect.Request[v1.ShutdownHostRequest]) (*connect.Response[v1.ShutdownHostResponse], error)
	// Restart the host machine running Home Cloud
	RestartHost(context.Context, *connect.Request[v1.RestartHostRequest]) (*connect.Response[v1.RestartHostResponse], error)
	// Install a Home Cloud application
	InstallApp(context.Context, *connect.Request[v1.InstallAppRequest]) (*connect.Response[v1.InstallAppResponse], error)
	// Delete a Home Cloud application
	DeleteApp(context.Context, *connect.Request[v1.DeleteAppRequest]) (*connect.Response[v1.DeleteAppResponse], error)
	// Update a Home Cloud application
	UpdateApp(context.Context, *connect.Request[v1.UpdateAppRequest]) (*connect.Response[v1.UpdateAppResponse], error)
	// Check for available NixOS and Daemon updates
	CheckForSystemUpdates(context.Context, *connect.Request[v1.CheckForSystemUpdatesRequest]) (*connect.Response[v1.CheckForSystemUpdatesResponse], error)
	// Check for available system (draft and home cloud) container updates
	CheckForContainerUpdates(context.Context, *connect.Request[v1.CheckForContainerUpdatesRequest]) (*connect.Response[v1.CheckForContainerUpdatesResponse], error)
	// Change the currently installed Daemon version
	ChangeDaemonVersion(context.Context, *connect.Request[v1.ChangeDaemonVersionRequest]) (*connect.Response[v1.ChangeDaemonVersionResponse], error)
	// Install available NixOS updates (call after calling CheckForSystemUpdates)
	InstallOSUpdate(context.Context, *connect.Request[v1.InstallOSUpdateRequest]) (*connect.Response[v1.InstallOSUpdateResponse], error)
	// Set a system (draft and home cloud) container image (used for updating images)
	SetSystemImage(context.Context, *connect.Request[v1.SetSystemImageRequest]) (*connect.Response[v1.SetSystemImageResponse], error)
	// Check the current health of all installed Home Cloud applications
	AppsHealthCheck(context.Context, *connect.Request[v1.AppsHealthCheckRequest]) (*connect.Response[v1.AppsHealthCheckResponse], error)
	// Get the current host machine stats (cpu, memory, drives)
	GetSystemStats(context.Context, *connect.Request[v1.GetSystemStatsRequest]) (*connect.Response[v1.GetSystemStatsResponse], error)
	// Check to validate if the device has gone through the onboarding process
	IsDeviceSetup(context.Context, *connect.Request[v1.IsDeviceSetupRequest]) (*connect.Response[v1.IsDeviceSetupResponse], error)
	// Initialize the device with the user's credentials and settings
	InitializeDevice(context.Context, *connect.Request[v1.InitializeDeviceRequest]) (*connect.Response[v1.InitializeDeviceResponse], error)
	// Login to the device
	Login(context.Context, *connect.Request[v1.LoginRequest]) (*connect.Response[v1.LoginResponse], error)
	// Get all apps available in the store
	GetAppsInStore(context.Context, *connect.Request[v1.GetAppsInStoreRequest]) (*connect.Response[v1.GetAppsInStoreResponse], error)
	// Get the device settings
	GetDeviceSettings(context.Context, *connect.Request[v1.GetDeviceSettingsRequest]) (*connect.Response[v1.GetDeviceSettingsResponse], error)
	// Subscribe to the server for events
	Subscribe(context.Context, *connect.Request[v1.SubscribeRequest]) (*connect.ServerStreamForClient[v1.ServerEvent], error)
}

WebServiceClient is a client for the platform.server.v1.WebService service.

func NewWebServiceClient 

func NewWebServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) WebServiceClient

NewWebServiceClient constructs a client for the platform.server.v1.WebService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type WebServiceHandler 

type WebServiceHandler interface {
	// Shutdown the host machine running Home Cloud
	ShutdownHost(context.Context, *connect.Request[v1.ShutdownHostRequest]) (*connect.Response[v1.ShutdownHostResponse], error)
	// Restart the host machine running Home Cloud
	RestartHost(context.Context, *connect.Request[v1.RestartHostRequest]) (*connect.Response[v1.RestartHostResponse], error)
	// Install a Home Cloud application
	InstallApp(context.Context, *connect.Request[v1.InstallAppRequest]) (*connect.Response[v1.InstallAppResponse], error)
	// Delete a Home Cloud application
	DeleteApp(context.Context, *connect.Request[v1.DeleteAppRequest]) (*connect.Response[v1.DeleteAppResponse], error)
	// Update a Home Cloud application
	UpdateApp(context.Context, *connect.Request[v1.UpdateAppRequest]) (*connect.Response[v1.UpdateAppResponse], error)
	// Check for available NixOS and Daemon updates
	CheckForSystemUpdates(context.Context, *connect.Request[v1.CheckForSystemUpdatesRequest]) (*connect.Response[v1.CheckForSystemUpdatesResponse], error)
	// Check for available system (draft and home cloud) container updates
	CheckForContainerUpdates(context.Context, *connect.Request[v1.CheckForContainerUpdatesRequest]) (*connect.Response[v1.CheckForContainerUpdatesResponse], error)
	// Change the currently installed Daemon version
	ChangeDaemonVersion(context.Context, *connect.Request[v1.ChangeDaemonVersionRequest]) (*connect.Response[v1.ChangeDaemonVersionResponse], error)
	// Install available NixOS updates (call after calling CheckForSystemUpdates)
	InstallOSUpdate(context.Context, *connect.Request[v1.InstallOSUpdateRequest]) (*connect.Response[v1.InstallOSUpdateResponse], error)
	// Set a system (draft and home cloud) container image (used for updating images)
	SetSystemImage(context.Context, *connect.Request[v1.SetSystemImageRequest]) (*connect.Response[v1.SetSystemImageResponse], error)
	// Check the current health of all installed Home Cloud applications
	AppsHealthCheck(context.Context, *connect.Request[v1.AppsHealthCheckRequest]) (*connect.Response[v1.AppsHealthCheckResponse], error)
	// Get the current host machine stats (cpu, memory, drives)
	GetSystemStats(context.Context, *connect.Request[v1.GetSystemStatsRequest]) (*connect.Response[v1.GetSystemStatsResponse], error)
	// Check to validate if the device has gone through the onboarding process
	IsDeviceSetup(context.Context, *connect.Request[v1.IsDeviceSetupRequest]) (*connect.Response[v1.IsDeviceSetupResponse], error)
	// Initialize the device with the user's credentials and settings
	InitializeDevice(context.Context, *connect.Request[v1.InitializeDeviceRequest]) (*connect.Response[v1.InitializeDeviceResponse], error)
	// Login to the device
	Login(context.Context, *connect.Request[v1.LoginRequest]) (*connect.Response[v1.LoginResponse], error)
	// Get all apps available in the store
	GetAppsInStore(context.Context, *connect.Request[v1.GetAppsInStoreRequest]) (*connect.Response[v1.GetAppsInStoreResponse], error)
	// Get the device settings
	GetDeviceSettings(context.Context, *connect.Request[v1.GetDeviceSettingsRequest]) (*connect.Response[v1.GetDeviceSettingsResponse], error)
	// Subscribe to the server for events
	Subscribe(context.Context, *connect.Request[v1.SubscribeRequest], *connect.ServerStream[v1.ServerEvent]) error
}

WebServiceHandler is an implementation of the platform.server.v1.WebService service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.