ni_measurementlink_service._internal.grpc_servicer

gRPC servicers for each version of the measurement service interface.

Module Contents

Classes

MeasurementServiceContext	Accessor for the measurement service's context-local state.
MeasurementServiceServicerV1	Measurement v1 servicer.
MeasurementServiceServicerV2	Measurement v2 servicer.

Attributes

measurement_service_context

class ni_measurementlink_service._internal.grpc_servicer.MeasurementServiceContext(grpc_context, pin_map_context, owner)

Accessor for the measurement service’s context-local state.

Parameters:

• grpc_context (grpc.ServicerContext) –

• pin_map_context (ni_measurementlink_service.session_management.PinMapContext) –

• owner (Optional[weakref.ReferenceType[object]]) –

property grpc_context: grpc.ServicerContext

Get the context for the RPC.

Return type:

grpc.ServicerContext

property owner: object

The owner of the server (e.g. measurement service).

Return type:

object

property pin_map_context: ni_measurementlink_service.session_management.PinMapContext

Get the pin map context for the RPC.

Return type:

ni_measurementlink_service.session_management.PinMapContext

property time_remaining: float

Get the time remaining for the RPC.

Return type:

float

mark_complete()

Mark the current RPC as complete.

Return type:

None

add_cancel_callback(cancel_callback)

Add a callback that is invoked when the RPC is canceled.

Parameters:

cancel_callback (Callable[[], None]) –

Return type:

None

cancel()

Cancel the RPC.

Return type:

None

abort(code, details)

Aborts the RPC.

Parameters:

• code (grpc.StatusCode) –

• details (str) –

Return type:

None

exception ni_measurementlink_service._internal.grpc_servicer.CustomRpcError(code, details)

Bases: grpc.RpcError

A custom exception class for handling gRPC RPC errors.

gRPC’s built-in RpcError is not directly configurable in Python, so this class enables the creation of custom RPC errors with specific error codes.

Parameters:

• code (grpc.StatusCode) –

• details (str) –

code()

Get the gRPC status code.

Return type:

grpc.StatusCode

details()

Get the gRPC status details.

Return type:

str

ni_measurementlink_service._internal.grpc_servicer.measurement_service_context: contextvars.ContextVar[MeasurementServiceContext]

class ni_measurementlink_service._internal.grpc_servicer.MeasurementServiceServicerV1(measurement_info, configuration_parameter_list, output_parameter_list, measure_function, owner)

Bases: ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v1.measurement_service_pb2_grpc.MeasurementServiceServicer

Measurement v1 servicer.

Parameters:

• measurement_info (ni_measurementlink_service.measurement.info.MeasurementInfo) –

• configuration_parameter_list (List[ni_measurementlink_service._internal.parameter.metadata.ParameterMetadata]) –

• output_parameter_list (List[ni_measurementlink_service._internal.parameter.metadata.ParameterMetadata]) –

• measure_function (Callable) –

• owner (object) –

GetMetadata(request, context)

RPC API to get measurement metadata.

Parameters:

• request (ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v1.measurement_service_pb2.GetMetadataRequest) –

• context (grpc.ServicerContext) –

Return type:

ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v1.measurement_service_pb2.GetMetadataResponse

Measure(request, context)

RPC API that executes the registered measurement method.

Parameters:

• request (ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v1.measurement_service_pb2.MeasureRequest) –

• context (grpc.ServicerContext) –

Return type:

ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v1.measurement_service_pb2.MeasureResponse

class ni_measurementlink_service._internal.grpc_servicer.MeasurementServiceServicerV2(measurement_info, configuration_parameter_list, output_parameter_list, measure_function, owner)

Bases: ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v2.measurement_service_pb2_grpc.MeasurementServiceServicer

Measurement v2 servicer.

Parameters:

• measurement_info (ni_measurementlink_service.measurement.info.MeasurementInfo) –

• configuration_parameter_list (List[ni_measurementlink_service._internal.parameter.metadata.ParameterMetadata]) –

• output_parameter_list (List[ni_measurementlink_service._internal.parameter.metadata.ParameterMetadata]) –

• measure_function (Callable) –

• owner (object) –

GetMetadata(request, context)

RPC API to get measurement metadata.

Parameters:

• request (ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v2.measurement_service_pb2.GetMetadataRequest) –

• context (grpc.ServicerContext) –

Return type:

ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v2.measurement_service_pb2.GetMetadataResponse

Measure(request, context)

RPC API that executes the registered measurement method.

Parameters:

• request (ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v2.measurement_service_pb2.MeasureRequest) –

• context (grpc.ServicerContext) –

Return type:

Generator[ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v2.measurement_service_pb2.MeasureResponse, None, None]