Package viam.module.v1

Interface ModuleServiceGrpc.AsyncService

All Known Implementing Classes:

BaseModule, ModuleRPCService, ModuleServiceGrpc.ModuleServiceImplBase

Enclosing class:

ModuleServiceGrpc

public static interface ModuleServiceGrpc.AsyncService

 ModuleService deals with modular resource registration
 

Method Summary

Modifier and Type	Method	Description
default void	addResource(Module.AddResourceRequest request, io.grpc.stub.StreamObserver<Module.AddResourceResponse> responseObserver)	AddResource tells a module about a new resource to handle
default void	ready(Module.ReadyRequest request, io.grpc.stub.StreamObserver<Module.ReadyResponse> responseObserver)	Ready determines if the server is started and ready to recieve resource configurations.
default void	reconfigureResource(Module.ReconfigureResourceRequest request, io.grpc.stub.StreamObserver<Module.ReconfigureResourceResponse> responseObserver)	ReconfigureResource tells a module to reconfigure an existing resource
default void	removeResource(Module.RemoveResourceRequest request, io.grpc.stub.StreamObserver<Module.RemoveResourceResponse> responseObserver)	RemoveResource tells a module to close/stop a component/service and remove it
default void	validateConfig(Module.ValidateConfigRequest request, io.grpc.stub.StreamObserver<Module.ValidateConfigResponse> responseObserver)	ValidateConfig determines whether the given config is valid and registers/returns both required and optional implicit dependencies.

Method Details

addResource

default void addResource(Module.AddResourceRequest request,
 io.grpc.stub.StreamObserver<Module.AddResourceResponse> responseObserver)

 AddResource tells a module about a new resource to handle
 

reconfigureResource

default void reconfigureResource(Module.ReconfigureResourceRequest request,
 io.grpc.stub.StreamObserver<Module.ReconfigureResourceResponse> responseObserver)

 ReconfigureResource tells a module to reconfigure an existing resource
 

removeResource

default void removeResource(Module.RemoveResourceRequest request,
 io.grpc.stub.StreamObserver<Module.RemoveResourceResponse> responseObserver)

 RemoveResource tells a module to close/stop a component/service and remove it
 

ready

default void ready(Module.ReadyRequest request,
 io.grpc.stub.StreamObserver<Module.ReadyResponse> responseObserver)

 Ready determines if the server is started and ready to recieve resource configurations.
 

validateConfig

default void validateConfig(Module.ValidateConfigRequest request,
 io.grpc.stub.StreamObserver<Module.ValidateConfigResponse> responseObserver)

 ValidateConfig determines whether the given config is valid and registers/returns
 both required and optional implicit dependencies.