from __future__ import annotations
from enum import IntEnum
from typing import TYPE_CHECKING
if TYPE_CHECKING:
import grpc
# This constant specifies the gRPC package and service used by this API.
# Customers can pass this value to the MeasurementLink discovery service to resolve the server instance that provides this interface.
GRPC_SERVICE_INTERFACE_NAME = 'nidaqmx_grpc.NiDAQmx'
# This constant specifies the API license key required by the NI gRPC Device Server that comes with
# MeasurementLink 2023 Q1.
MEASUREMENTLINK_23Q1_NIDAQMX_PYTHON_API_KEY = '147D9BA7-BE75-4B29-8591-BA4A737AA8CF'
[docs]
class SessionInitializationBehavior(IntEnum):
AUTO = 0
r'''
The NI gRPC Device Server will attach to an existing session with the specified name if it exists, otherwise the server
will initialize a new session.
Note:
When using the Session as a context manager and the context exits, the behavior depends on what happened when the constructor
was called. If it resulted in a new session being initialized on the NI gRPC Device Server, then it will automatically close the
server session. If it instead attached to an existing session, then it will detach from the server session and leave it open.
'''
INITIALIZE_SERVER_SESSION = 1
r'''
Require the NI gRPC Device Server to initialize a new session with the specified name.
Note:
When using the Session as a context manager and the context exits, it will automatically close the
server session.
'''
ATTACH_TO_SERVER_SESSION = 2
r'''
Require the NI gRPC Device Server to attach to an existing session with the specified name.
Note:
When using the Session as a context manager and the context exits, it will detach from the server session
and leave it open.
'''
[docs]
class GrpcSessionOptions:
'''Collection of options that specifies session behaviors related to gRPC.'''
def __init__(
self,
grpc_channel: grpc.Channel,
session_name: str,
*,
api_key=MEASUREMENTLINK_23Q1_NIDAQMX_PYTHON_API_KEY,
initialization_behavior=SessionInitializationBehavior.AUTO
):
r'''Collection of options that specifies session behaviors related to gRPC.
Creates and returns an object you can pass to a Session constructor.
Args:
grpc_channel (grpc.Channel): Specifies the channel to the NI gRPC Device Server.
session_name (str): User-specified name that identifies the driver session on the NI gRPC Device
Server. This is different from the resource name parameter many APIs take as a separate
parameter. Specifying a name makes it easy to share sessions across multiple gRPC clients.
You can use an empty string if you want to always initialize a new session on the server.
To attach to an existing session, you must specify the session name it was initialized with.
api_key (str): Specifies the API license key required by the NI gRPC Device Server.
initialization_behavior (enum): Specifies whether it is acceptable to initialize a new
session or attach to an existing one, or if only one of the behaviors is desired.
The driver session exists on the NI gRPC Device Server.
'''
self.grpc_channel = grpc_channel
self.session_name = session_name
self.api_key = api_key
self.initialization_behavior = initialization_behavior