ni.panels.v1.panel_service_pb2_grpc =================================== .. py:module:: ni.panels.v1.panel_service_pb2_grpc Attributes ---------- .. autoapisummary:: ni.panels.v1.panel_service_pb2_grpc._T Classes ------- .. autoapisummary:: ni.panels.v1.panel_service_pb2_grpc._MaybeAsyncIterator ni.panels.v1.panel_service_pb2_grpc._ServicerContext ni.panels.v1.panel_service_pb2_grpc.PanelServiceStub ni.panels.v1.panel_service_pb2_grpc.PanelServiceAsyncStub ni.panels.v1.panel_service_pb2_grpc.PanelServiceServicer Functions --------- .. autoapisummary:: ni.panels.v1.panel_service_pb2_grpc.add_PanelServiceServicer_to_server Module Contents --------------- .. py:data:: _T .. py:class:: _MaybeAsyncIterator Bases: :py:obj:`collections.abc.AsyncIterator`\ [\ :py:obj:`_T`\ ], :py:obj:`collections.abc.Iterator`\ [\ :py:obj:`_T`\ ] .. py:attribute:: __slots__ :value: () .. py:method:: __anext__() :abstractmethod: :async: Return the next item or raise StopAsyncIteration when exhausted. .. py:method:: __aiter__() .. py:method:: __subclasshook__(C) :classmethod: .. py:attribute:: __class_getitem__ .. py:method:: __next__() :abstractmethod: Return the next item from the iterator. When exhausted, raise StopIteration .. py:method:: __iter__() .. py:class:: _ServicerContext Bases: :py:obj:`grpc.ServicerContext`, :py:obj:`grpc.aio.ServicerContext` A context object passed to method implementations. .. py:method:: invocation_metadata() :abstractmethod: Accesses the metadata sent by the client. :returns: The invocation :term:`metadata`. .. py:method:: peer() :abstractmethod: Identifies the peer that invoked the RPC being serviced. :returns: A string identifying the peer that invoked the RPC being serviced. The string format is determined by gRPC runtime. .. py:method:: peer_identities() :abstractmethod: Gets one or more peer identity(s). Equivalent to servicer_context.auth_context().get(servicer_context.peer_identity_key()) :returns: An iterable of the identities, or None if the call is not authenticated. Each identity is returned as a raw bytes type. .. py:method:: peer_identity_key() :abstractmethod: The auth property used to identify the peer. For example, "x509_common_name" or "x509_subject_alternative_name" are used to identify an SSL peer. :returns: The auth property (string) that indicates the peer identity, or None if the call is not authenticated. .. py:method:: auth_context() :abstractmethod: Gets the auth context for the call. :returns: A map of strings to an iterable of bytes for each auth property. .. py:method:: set_compression(compression) :abstractmethod: Set the compression algorithm to be used for the entire call. :param compression: An element of grpc.Compression, e.g. grpc.Compression.Gzip. .. py:method:: send_initial_metadata(initial_metadata) :abstractmethod: Sends the initial metadata value to the client. This method need not be called by implementations if they have no metadata to add to what the gRPC runtime will transmit. :param initial_metadata: The initial :term:`metadata`. .. py:method:: set_trailing_metadata(trailing_metadata) :abstractmethod: Sets the trailing metadata for the RPC. Sets the trailing metadata to be sent upon completion of the RPC. If this method is invoked multiple times throughout the lifetime of an RPC, the value supplied in the final invocation will be the value sent over the wire. This method need not be called by implementations if they have no metadata to add to what the gRPC runtime will transmit. :param trailing_metadata: The trailing :term:`metadata`. .. py:method:: trailing_metadata() :abstractmethod: Access value to be used as trailing metadata upon RPC completion. This is an EXPERIMENTAL API. :returns: The trailing :term:`metadata` for the RPC. .. py:method:: abort(code, details) :abstractmethod: Raises an exception to terminate the RPC with a non-OK status. The code and details passed as arguments will supersede any existing ones. :param code: A StatusCode object to be sent to the client. It must not be StatusCode.OK. :param details: A UTF-8-encodable string to be sent to the client upon termination of the RPC. :raises Exception: An exception is always raised to signal the abortion the RPC to the gRPC runtime. .. py:method:: abort_with_status(status) :abstractmethod: Raises an exception to terminate the RPC with a non-OK status. The status passed as argument will supersede any existing status code, status message and trailing metadata. This is an EXPERIMENTAL API. :param status: A grpc.Status object. The status code in it must not be StatusCode.OK. :raises Exception: An exception is always raised to signal the abortion the RPC to the gRPC runtime. .. py:method:: set_code(code) :abstractmethod: Sets the value to be used as status code upon RPC completion. This method need not be called by method implementations if they wish the gRPC runtime to determine the status code of the RPC. :param code: A StatusCode object to be sent to the client. .. py:method:: set_details(details) :abstractmethod: Sets the value to be used as detail string upon RPC completion. This method need not be called by method implementations if they have no details to transmit. :param details: A UTF-8-encodable string to be sent to the client upon termination of the RPC. .. py:method:: code() :abstractmethod: Accesses the value to be used as status code upon RPC completion. This is an EXPERIMENTAL API. :returns: The StatusCode value for the RPC. .. py:method:: details() :abstractmethod: Accesses the value to be used as detail string upon RPC completion. This is an EXPERIMENTAL API. :returns: The details string of the RPC. .. py:method:: disable_next_message_compression() :abstractmethod: Disables compression for the next response message. This method will override any compression configuration set during server creation or set on the call. .. py:method:: is_active() :abstractmethod: Describes whether the RPC is active or has terminated. :returns: True if RPC is active, False otherwise. :rtype: bool .. py:method:: time_remaining() :abstractmethod: Describes the length of allowed time remaining for the RPC. :returns: A nonnegative float indicating the length of allowed time in seconds remaining for the RPC to complete before it is considered to have timed out, or None if no deadline was specified for the RPC. .. py:method:: cancel() :abstractmethod: Cancels the RPC. Idempotent and has no effect if the RPC has already terminated. .. py:method:: add_callback(callback) :abstractmethod: Registers a callback to be called on RPC termination. :param callback: A no-parameter callable to be called on RPC termination. :returns: True if the callback was added and will be called later; False if the callback was not added and will not be called (because the RPC already terminated or some other reason). .. py:attribute:: __slots__ :value: () .. py:method:: read() :abstractmethod: :async: Reads one message from the RPC. Only one read operation is allowed simultaneously. :returns: A response message of the RPC. :raises An RpcError exception if the read failed.: .. py:method:: write(message) :abstractmethod: :async: Writes one message to the RPC. Only one write operation is allowed simultaneously. :raises An RpcError exception if the write failed.: .. py:method:: add_done_callback(callback) Registers a callback to be called on RPC termination. This is an EXPERIMENTAL API. :param callback: A callable object will be called with the servicer context object as its only argument. .. py:method:: cancelled() Return True if the RPC is cancelled. The RPC is cancelled when the cancellation was requested with cancel(). This is an EXPERIMENTAL API. :returns: A bool indicates whether the RPC is cancelled or not. .. py:method:: done() Return True if the RPC is done. An RPC is done if the RPC is completed, cancelled or aborted. This is an EXPERIMENTAL API. :returns: A bool indicates if the RPC is done. .. py:attribute:: _is_protocol :value: False .. py:method:: __class_getitem__(params) :classmethod: Parameterizes a generic class. At least, parameterizing a generic class is the *main* thing this method does. For example, for some generic class `Foo`, this is called when we do `Foo[int]` - there, with `cls=Foo` and `params=int`. However, note that this method is also called when defining generic classes in the first place with `class Foo(Generic[T]): ...`. .. py:method:: __init_subclass__(*args, **kwargs) :classmethod: .. py:class:: PanelServiceStub(channel) Service interface for interacting with NI panels .. py:method:: __init__(channel) .. py:attribute:: StartPanel :type: grpc.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.StartPanelRequest, ni.panels.v1.panel_service_pb2.StartPanelResponse] Start a panel using the provided configuration (or connect to if it has already been started) Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The panel configuration has an invalid argument. * NOT_FOUND: * The panel configuration includes a file that was not found. .. py:attribute:: StopPanel :type: grpc.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.StopPanelRequest, ni.panels.v1.panel_service_pb2.StopPanelResponse] Stop a panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. .. py:attribute:: EnumeratePanels :type: grpc.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.EnumeratePanelsRequest, ni.panels.v1.panel_service_pb2.EnumeratePanelsResponse] Enumerate the panels available in the system, including information about the state of the panels and what values they have. Status Codes for errors: .. py:attribute:: GetValue :type: grpc.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.GetValueRequest, ni.panels.v1.panel_service_pb2.GetValueResponse] Get a value for a control on the panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The value identifier contains invalid characters. * NOT_FOUND: * The value with the specified identifier was not found. .. py:attribute:: TryGetValue :type: grpc.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.TryGetValueRequest, ni.panels.v1.panel_service_pb2.TryGetValueResponse] Try to get a value for a control on the panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The value identifier contains invalid characters. .. py:attribute:: SetValue :type: grpc.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.SetValueRequest, ni.panels.v1.panel_service_pb2.SetValueResponse] Set a value for a control on the panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The value identifier contains invalid characters. .. py:class:: PanelServiceAsyncStub Service interface for interacting with NI panels .. py:attribute:: StartPanel :type: grpc.aio.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.StartPanelRequest, ni.panels.v1.panel_service_pb2.StartPanelResponse] Start a panel using the provided configuration (or connect to if it has already been started) Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The panel configuration has an invalid argument. * NOT_FOUND: * The panel configuration includes a file that was not found. .. py:attribute:: StopPanel :type: grpc.aio.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.StopPanelRequest, ni.panels.v1.panel_service_pb2.StopPanelResponse] Stop a panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. .. py:attribute:: EnumeratePanels :type: grpc.aio.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.EnumeratePanelsRequest, ni.panels.v1.panel_service_pb2.EnumeratePanelsResponse] Enumerate the panels available in the system, including information about the state of the panels and what values they have. Status Codes for errors: .. py:attribute:: GetValue :type: grpc.aio.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.GetValueRequest, ni.panels.v1.panel_service_pb2.GetValueResponse] Get a value for a control on the panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The value identifier contains invalid characters. * NOT_FOUND: * The value with the specified identifier was not found. .. py:attribute:: TryGetValue :type: grpc.aio.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.TryGetValueRequest, ni.panels.v1.panel_service_pb2.TryGetValueResponse] Try to get a value for a control on the panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The value identifier contains invalid characters. .. py:attribute:: SetValue :type: grpc.aio.UnaryUnaryMultiCallable[ni.panels.v1.panel_service_pb2.SetValueRequest, ni.panels.v1.panel_service_pb2.SetValueResponse] Set a value for a control on the panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The value identifier contains invalid characters. .. py:class:: PanelServiceServicer Service interface for interacting with NI panels .. py:method:: StartPanel(request, context) :abstractmethod: Start a panel using the provided configuration (or connect to if it has already been started) Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The panel configuration has an invalid argument. * NOT_FOUND: * The panel configuration includes a file that was not found. .. py:method:: StopPanel(request, context) :abstractmethod: Stop a panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. .. py:method:: EnumeratePanels(request, context) :abstractmethod: Enumerate the panels available in the system, including information about the state of the panels and what values they have. Status Codes for errors: .. py:method:: GetValue(request, context) :abstractmethod: Get a value for a control on the panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The value identifier contains invalid characters. * NOT_FOUND: * The value with the specified identifier was not found. .. py:method:: TryGetValue(request, context) :abstractmethod: Try to get a value for a control on the panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The value identifier contains invalid characters. .. py:method:: SetValue(request, context) :abstractmethod: Set a value for a control on the panel Status Codes for errors: * INVALID_ARGUMENT: * The panel identifier contains invalid characters. * The value identifier contains invalid characters. .. py:function:: add_PanelServiceServicer_to_server(servicer, server)