abstract class MinknowApi::Protocol::ProtocolService::Service

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.cr

Instance Method Summary

Instance Method Detail

abstract def associate_post_processing_analysis_for_protocol(request : MinknowApi::Protocol::AssociatePostProcessingAnalysisRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::AssociatePostProcessingAnalysisResponse #

[View source]
abstract def begin_hardware_check(request : MinknowApi::Protocol::BeginHardwareCheckRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::BeginHardwareCheckResponse #

[View source]
abstract def begin_platform_qc(request : MinknowApi::Protocol::BeginPlatformQcRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::BeginPlatformQcResponse #

[View source]
abstract def begin_protocol(request : MinknowApi::Protocol::BeginProtocolRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::BeginProtocolResponse #

[View source]
def bidi_streaming?(method : String) : Bool #
Description copied from class GRPC::Service

bidi_streaming? returns true if method is a bidirectional streaming RPC. Generated service base classes override this; the default is false (unary).


[View source]
abstract def clear_protocol_history_data(request : MinknowApi::Protocol::ClearProtocolHistoryDataRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::ClearProtocolHistoryDataResponse #

[View source]
def dispatch(method : String, body : Bytes, ctx : GRPC::ServerContext) : Tuple(Bytes, GRPC::Status) #
Description copied from class GRPC::Service

dispatch routes an incoming unary RPC call to the correct method implementation. Returns {response_body : Bytes, status : Status}.


[View source]
def dispatch_bidi_stream(method : String, requests : GRPC::RawRequestStream, ctx : GRPC::ServerContext, writer : GRPC::RawResponseStream) : GRPC::Status #
Description copied from class GRPC::Service

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.


[View source]
def dispatch_server_stream(method : String, body : Bytes, ctx : GRPC::ServerContext, writer : GRPC::RawResponseStream) : GRPC::Status #
Description copied from class GRPC::Service

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.


[View source]
abstract def generate_run_report(request : MinknowApi::Protocol::GenerateRunReportRequest, writer : GRPC::ResponseStream(MinknowApi::Protocol::GenerateRunReportResponse), ctx : GRPC::ServerContext) : GRPC::Status #

[View source]
abstract def get_context_info(request : MinknowApi::Protocol::GetContextInfoRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::GetContextInfoResponse #

[View source]
abstract def get_current_protocol_run(request : MinknowApi::Protocol::GetCurrentProtocolRunRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::ProtocolRunInfo #

[View source]
abstract def get_protocol_purpose(request : MinknowApi::Protocol::GetProtocolPurposeRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::GetProtocolPurposeResponse #

[View source]
abstract def get_run_info(request : MinknowApi::Protocol::GetRunInfoRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::ProtocolRunInfo #

[View source]
abstract def list_protocol_group_ids(request : MinknowApi::Protocol::ListProtocolGroupIdsRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::ListProtocolGroupIdsResponse #

[View source]
abstract def list_protocol_runs(request : MinknowApi::Protocol::ListProtocolRunsRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::ListProtocolRunsResponse #

[View source]
abstract def list_protocols(request : MinknowApi::Protocol::ListProtocolsRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::ListProtocolsResponse #

[View source]
abstract def pause_protocol(request : MinknowApi::Protocol::PauseProtocolRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::PauseProtocolResponse #

[View source]
abstract def protocol_phase_management(requests : GRPC::RequestStream(MinknowApi::Protocol::ProtocolPhaseManagementRequest), writer : GRPC::ResponseStream(MinknowApi::Protocol::ProtocolPhaseManagementResponse), ctx : GRPC::ServerContext) : GRPC::Status #

[View source]
abstract def resume_protocol(request : MinknowApi::Protocol::ResumeProtocolRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::ResumeProtocolResponse #

[View source]
def server_streaming?(method : String) : Bool #
Description copied from class GRPC::Service

server_streaming? returns true if method is a server-streaming RPC. Generated service base classes override this; the default is false (unary).


[View source]
def service_full_name : String #
Description copied from class GRPC::Service

service_full_name returns the full gRPC service name (e.g. "helloworld.Greeter").


[View source]
abstract def set_context_info(request : MinknowApi::Protocol::SetContextInfoRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::SetContextInfoResponse #

[View source]
abstract def set_hardware_check_result(request : MinknowApi::Protocol::SetHardwareCheckResultRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::SetHardwareCheckResultResponse #

[View source]
abstract def set_platform_qc_result(request : MinknowApi::Protocol::SetPlatformQcResultRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::SetPlatformQcResultResponse #

[View source]
abstract def set_protocol_purpose(request : MinknowApi::Protocol::SetProtocolPurposeRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::SetProtocolPurposeResponse #

[View source]
abstract def set_protocol_script_restartable(request : MinknowApi::Protocol::SetProtocolRestartableRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::SetProtocolRestartableResponse #

[View source]
abstract def start_protocol(request : MinknowApi::Protocol::StartProtocolRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::StartProtocolResponse #

[View source]
abstract def stop_protocol(request : MinknowApi::Protocol::StopProtocolRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::StopProtocolResponse #

[View source]
abstract def trigger_mux_scan(request : MinknowApi::Protocol::TriggerMuxScanRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::TriggerMuxScanResponse #

[View source]
abstract def wait_for_finished(request : MinknowApi::Protocol::WaitForFinishedRequest, ctx : GRPC::ServerContext) : MinknowApi::Protocol::ProtocolRunInfo #

[View source]
abstract def watch_clearing_historic_data(request : MinknowApi::Protocol::WatchClearingHistoricDataRequest, writer : GRPC::ResponseStream(MinknowApi::Protocol::ClearedHistoricData), ctx : GRPC::ServerContext) : GRPC::Status #

[View source]
abstract def watch_current_protocol_run(request : MinknowApi::Protocol::WatchCurrentProtocolRunRequest, writer : GRPC::ResponseStream(MinknowApi::Protocol::ProtocolRunInfo), ctx : GRPC::ServerContext) : GRPC::Status #

[View source]