ni.datamonikers.v1.client

Public API for accessing the NI Data Moniker Service.

Classes

MonikerClient

Client for accessing the NI Data Moniker Service.

Package Contents

class ni.datamonikers.v1.client.MonikerClient(*, service_location=None, grpc_channel=None, grpc_channel_pool=None)

Client for accessing the NI Data Moniker Service.

Initialize the Moniker Client.

Parameters:

• service_location (str | None) – The address of the data moniker service location (recommended).

• grpc_channel (grpc.Channel | None) – A data moniker gRPC channel (optional).

• grpc_channel_pool (ni_grpc_extensions.channelpool.GrpcChannelPool | None) – A gRPC channel pool (recommended).

Either service_location or grpc_channel must be provided. If both are provided, grpc_channel takes precedence.

__slots__ = ('_lock', '_owns_grpc_channel_pool', '_service_location', '_grpc_channel_pool', '_stub')

__enter__()

Enter the runtime context of the MonikerClient.

Return type:

Self

__exit__(exc_type, exc_val, traceback)

Exit the runtime context of the MonikerClient.

Parameters:

• exc_type (type[BaseException] | None)

• exc_val (BaseException | None)

• traceback (types.TracebackType | None)

Return type:

None

close()

Close the client and clean up resources that it owns.

Return type:

None

begin_sideband_stream(request)

Begin a sideband stream.

Parameters:

request (ni.datamonikers.v1.data_moniker_pb2.BeginMonikerSidebandStreamRequest)

Return type:

ni.datamonikers.v1.data_moniker_pb2.BeginMonikerSidebandStreamResponse

stream_read(moniker_list)

Stream read data from monikers.

Parameters:

moniker_list (ni.datamonikers.v1.data_moniker_pb2.MonikerList)

Return type:

Iterator[ni.datamonikers.v1.data_moniker_pb2.MonikerReadResult]

stream_write(requests)

Stream write data to monikers.

Parameters:

requests (Iterator[ni.datamonikers.v1.data_moniker_pb2.MonikerWriteRequest])

Return type:

Iterator[ni.datamonikers.v1.data_moniker_pb2.StreamWriteResponse]

stream_read_write(requests)

Stream read and write data with monikers.

Parameters:

requests (Iterator[ni.datamonikers.v1.data_moniker_pb2.MonikerWriteRequest])

Return type:

Iterator[ni.datamonikers.v1.data_moniker_pb2.MonikerReadResult]

read_from_moniker(moniker)

Read data from a moniker.

Parameters:

moniker (ni.datamonikers.v1.data_moniker_pb2.Moniker)

Return type:

ni.datamonikers.v1.data_moniker_pb2.ReadFromMonikerResult

write_to_moniker(request)

Write data to a moniker.

Parameters:

request (ni.datamonikers.v1.data_moniker_pb2.WriteToMonikerRequest)

Return type:

ni.datamonikers.v1.data_moniker_pb2.WriteToMonikerResponse