abstract class
MinknowApi::Protocol::ProtocolService::Service
- MinknowApi::Protocol::ProtocolService::Service
- GRPC::Service
- Reference
- Object
Overview
Service is the generated abstract base class for server implementations. Subclass it and implement each RPC method, then register with GRPC::Server#handle.
Defined in:
generated/minknow_api/protocol.grpc.crInstance Method Summary
- #associate_post_processing_analysis_for_protocol(request : AssociatePostProcessingAnalysisRequest, ctx : GRPC::ServerContext) : AssociatePostProcessingAnalysisResponse
- #begin_hardware_check(request : BeginHardwareCheckRequest, ctx : GRPC::ServerContext) : BeginHardwareCheckResponse
- #begin_platform_qc(request : BeginPlatformQcRequest, ctx : GRPC::ServerContext) : BeginPlatformQcResponse
- #begin_protocol(request : BeginProtocolRequest, ctx : GRPC::ServerContext) : BeginProtocolResponse
-
#bidi_streaming?(method : String) : Bool
bidi_streaming? returns true if method is a bidirectional streaming RPC.
- #clear_protocol_history_data(request : ClearProtocolHistoryDataRequest, ctx : GRPC::ServerContext) : ClearProtocolHistoryDataResponse
-
#dispatch(method : String, body : Bytes, ctx : GRPC::ServerContext) : Tuple(Bytes, GRPC::Status)
dispatch routes an incoming unary RPC call to the correct method implementation.
-
#dispatch_bidi_stream(method : String, requests : GRPC::RawRequestStream, ctx : GRPC::ServerContext, writer : GRPC::RawResponseStream) : GRPC::Status
dispatch_bidi_stream dispatches a bidirectional streaming RPC.
-
#dispatch_server_stream(method : String, body : Bytes, ctx : GRPC::ServerContext, writer : GRPC::RawResponseStream) : GRPC::Status
dispatch_server_stream dispatches a server-streaming RPC.
- #generate_run_report(request : GenerateRunReportRequest, writer : GRPC::ResponseStream(GenerateRunReportResponse), ctx : GRPC::ServerContext) : GRPC::Status
- #get_context_info(request : GetContextInfoRequest, ctx : GRPC::ServerContext) : GetContextInfoResponse
- #get_current_protocol_run(request : GetCurrentProtocolRunRequest, ctx : GRPC::ServerContext) : ProtocolRunInfo
- #get_protocol_purpose(request : GetProtocolPurposeRequest, ctx : GRPC::ServerContext) : GetProtocolPurposeResponse
- #get_run_info(request : GetRunInfoRequest, ctx : GRPC::ServerContext) : ProtocolRunInfo
- #list_protocol_group_ids(request : ListProtocolGroupIdsRequest, ctx : GRPC::ServerContext) : ListProtocolGroupIdsResponse
- #list_protocol_runs(request : ListProtocolRunsRequest, ctx : GRPC::ServerContext) : ListProtocolRunsResponse
- #list_protocols(request : ListProtocolsRequest, ctx : GRPC::ServerContext) : ListProtocolsResponse
- #pause_protocol(request : PauseProtocolRequest, ctx : GRPC::ServerContext) : PauseProtocolResponse
- #protocol_phase_management(requests : GRPC::RequestStream(ProtocolPhaseManagementRequest), writer : GRPC::ResponseStream(ProtocolPhaseManagementResponse), ctx : GRPC::ServerContext) : GRPC::Status
- #resume_protocol(request : ResumeProtocolRequest, ctx : GRPC::ServerContext) : ResumeProtocolResponse
-
#server_streaming?(method : String) : Bool
server_streaming? returns true if method is a server-streaming RPC.
-
#service_full_name : String
service_full_name returns the full gRPC service name (e.g.
- #set_context_info(request : SetContextInfoRequest, ctx : GRPC::ServerContext) : SetContextInfoResponse
- #set_hardware_check_result(request : SetHardwareCheckResultRequest, ctx : GRPC::ServerContext) : SetHardwareCheckResultResponse
- #set_platform_qc_result(request : SetPlatformQcResultRequest, ctx : GRPC::ServerContext) : SetPlatformQcResultResponse
- #set_protocol_purpose(request : SetProtocolPurposeRequest, ctx : GRPC::ServerContext) : SetProtocolPurposeResponse
- #set_protocol_script_restartable(request : SetProtocolRestartableRequest, ctx : GRPC::ServerContext) : SetProtocolRestartableResponse
- #start_protocol(request : StartProtocolRequest, ctx : GRPC::ServerContext) : StartProtocolResponse
- #stop_protocol(request : StopProtocolRequest, ctx : GRPC::ServerContext) : StopProtocolResponse
- #trigger_mux_scan(request : TriggerMuxScanRequest, ctx : GRPC::ServerContext) : TriggerMuxScanResponse
- #wait_for_finished(request : WaitForFinishedRequest, ctx : GRPC::ServerContext) : ProtocolRunInfo
- #watch_clearing_historic_data(request : WatchClearingHistoricDataRequest, writer : GRPC::ResponseStream(ClearedHistoricData), ctx : GRPC::ServerContext) : GRPC::Status
- #watch_current_protocol_run(request : WatchCurrentProtocolRunRequest, writer : GRPC::ResponseStream(ProtocolRunInfo), ctx : GRPC::ServerContext) : GRPC::Status
Instance Method Detail
bidi_streaming? returns true if method is a bidirectional streaming RPC. Generated service base classes override this; the default is false (unary).
dispatch routes an incoming unary RPC call to the correct method implementation. Returns {response_body : Bytes, status : Status}.
dispatch_bidi_stream dispatches a bidirectional streaming RPC. requests is a RawRequestStream that yields raw message bytes as they arrive. The transport passes a RawResponseStream; generated subclasses wrap it in a typed ResponseStream(T) before handing off to the user implementation.
dispatch_server_stream dispatches a server-streaming RPC. The transport passes a RawResponseStream; generated subclasses wrap it in a typed ResponseStream(T) before handing off to the user implementation.
server_streaming? returns true if method is a server-streaming RPC. Generated service base classes override this; the default is false (unary).
service_full_name returns the full gRPC service name (e.g. "helloworld.Greeter").