ni.datamonikers.v1.data_moniker_pb2

Attributes

`DESCRIPTOR`
`UNKNOWN`	No strategy selected.
`GRPC`	Standard gRPC transport.
`SHARED_MEMORY`	Shared memory transport. Client and server must be on the same machine.
`DOUBLE_BUFFERED_SHARED_MEMORY`	Same as SHARED_MEMORY except double buffered. This uses more memory but
`SOCKETS`	TCP Socket-based transport.
`SOCKETS_LOW_LATENCY`	TCP Socket-based transport optimized for lower latency at the expense
`HYPERVISOR_SOCKETS`	Hypervisor-assisted socket transport. Not currently implemented.
`RDMA`	RDMA-based transport. Requires that the network card on both the client
`RDMA_LOW_LATENCY`	RDMA transport optimized for lower latency at the expense of higher
`global___SidebandStrategy`
`global___Moniker`
`global___MonikerValues`
`global___MonikerList`
`global___BeginMonikerSidebandStreamRequest`
`global___BeginMonikerSidebandStreamResponse`
`global___MonikerWriteRequest`
`global___MonikerReadResult`
`global___StreamWriteResponse`
`global___ReadFromMonikerResult`
`global___WriteToMonikerRequest`
`global___WriteToMonikerResponse`

Classes

`SidebandStrategy`
`Moniker`	Identifier used to represent a data source from which data values can
`MonikerValues`	Message which contains a batch of data values.
`MonikerList`	Message which identifies the set of read and write monikers for a
`BeginMonikerSidebandStreamRequest`	Abstract base class for protocol messages.
`BeginMonikerSidebandStreamResponse`	Abstract base class for protocol messages.
`MonikerWriteRequest`	Request message used to perform streaming writes.
`MonikerReadResult`	Response message used to perform streaming reads.
`StreamWriteResponse`	Abstract base class for protocol messages.
`ReadFromMonikerResult`	Abstract base class for protocol messages.
`WriteToMonikerRequest`	Abstract base class for protocol messages.
`WriteToMonikerResponse`	Abstract base class for protocol messages.

Package Contents

ni.datamonikers.v1.data_moniker_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class ni.datamonikers.v1.data_moniker_pb2.SidebandStrategy: Bases: _SidebandStrategy

ni.datamonikers.v1.data_moniker_pb2.UNKNOWN: SidebandStrategy: No strategy selected.

ni.datamonikers.v1.data_moniker_pb2.GRPC: SidebandStrategy: Standard gRPC transport.

ni.datamonikers.v1.data_moniker_pb2.SHARED_MEMORY: SidebandStrategy: Shared memory transport. Client and server must be on the same machine.

ni.datamonikers.v1.data_moniker_pb2.DOUBLE_BUFFERED_SHARED_MEMORY: SidebandStrategy: Same as SHARED_MEMORY except double buffered. This uses more memory but allows the client and server to read and write at the same time without blocking each other.

ni.datamonikers.v1.data_moniker_pb2.SOCKETS: SidebandStrategy: TCP Socket-based transport.

ni.datamonikers.v1.data_moniker_pb2.SOCKETS_LOW_LATENCY: SidebandStrategy: TCP Socket-based transport optimized for lower latency at the expense of higher CPU usage.

ni.datamonikers.v1.data_moniker_pb2.HYPERVISOR_SOCKETS: SidebandStrategy: Hypervisor-assisted socket transport. Not currently implemented.

ni.datamonikers.v1.data_moniker_pb2.RDMA: SidebandStrategy: RDMA-based transport. Requires that the network card on both the client and the server support RDMA.

ni.datamonikers.v1.data_moniker_pb2.RDMA_LOW_LATENCY: SidebandStrategy: RDMA transport optimized for lower latency at the expense of higher CPU usage.

ni.datamonikers.v1.data_moniker_pb2.global___SidebandStrategy

class ni.datamonikers.v1.data_moniker_pb2.Moniker(*, service_location=..., data_source=..., data_instance=...)

Bases: google.protobuf.message.Message

Identifier used to represent a data source from which data values can be read or written.

Parameters:

service_location (str)
data_source (str)
data_instance (int)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

SERVICE_LOCATION_FIELD_NUMBER: int

DATA_SOURCE_FIELD_NUMBER: int

DATA_INSTANCE_FIELD_NUMBER: int

service_location: str: Service location or endpoint identifier.

data_source: str: Logical data source name.

data_instance: int: Specific instance identifier within the data source.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.datamonikers.v1.data_moniker_pb2.global___Moniker

class ni.datamonikers.v1.data_moniker_pb2.MonikerValues(*, values=...)

Bases: google.protobuf.message.Message

Message which contains a batch of data values.

For reads, values contains the returned data values for one or more data monikers. For writes, values contains the data values to be applied to one or more data monikers.

Parameters:: values (collections.abc.Iterable[google.protobuf.any_pb2.Any] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

VALUES_FIELD_NUMBER: int

property values: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.any_pb2.Any]

Data values carried as protobuf Any messages.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.any_pb2.Any]

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.datamonikers.v1.data_moniker_pb2.global___MonikerValues

class ni.datamonikers.v1.data_moniker_pb2.MonikerList(*, is_initial_write=..., read_monikers=..., write_monikers=...)

Bases: google.protobuf.message.Message

Message which identifies the set of read and write monikers for a particular operation.

Parameters:

is_initial_write (bool)
read_monikers (collections.abc.Iterable[global___Moniker] | None)
write_monikers (collections.abc.Iterable[global___Moniker] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

IS_INITIAL_WRITE_FIELD_NUMBER: int

READ_MONIKERS_FIELD_NUMBER: int

WRITE_MONIKERS_FIELD_NUMBER: int

is_initial_write: bool: Deprecated. Preserved for backward compatibility.

property read_monikers: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Moniker]

Monikers from which to read.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Moniker]

property write_monikers: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Moniker]

Monikers to update with new data values.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Moniker]

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.datamonikers.v1.data_moniker_pb2.global___MonikerList

class ni.datamonikers.v1.data_moniker_pb2.BeginMonikerSidebandStreamRequest(*, strategy=..., monikers=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

strategy (global___SidebandStrategy)
monikers (global___MonikerList | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

STRATEGY_FIELD_NUMBER: int

MONIKERS_FIELD_NUMBER: int

strategy: global___SidebandStrategy: The transport to use for the sideband communication channel.

property monikers: global___MonikerList

Monikers participating in the sideband communication channel.

Return type:: global___MonikerList

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.datamonikers.v1.data_moniker_pb2.global___BeginMonikerSidebandStreamRequest

class ni.datamonikers.v1.data_moniker_pb2.BeginMonikerSidebandStreamResponse(*, strategy=..., connection_url=..., sideband_identifier=..., buffer_size=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

strategy (global___SidebandStrategy)
connection_url (str)
sideband_identifier (str)
buffer_size (int)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

STRATEGY_FIELD_NUMBER: int

CONNECTION_URL_FIELD_NUMBER: int

SIDEBAND_IDENTIFIER_FIELD_NUMBER: int

BUFFER_SIZE_FIELD_NUMBER: int

strategy: global___SidebandStrategy: Selected transport used for the the sideband communication channel.

connection_url: str: Transport-specific URL or endpoint used to establish the sideband connection.

sideband_identifier: str: Identifier used to identify communication session within the transport.

buffer_size: int: The buffer size in bytes used for the sideband transport.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.datamonikers.v1.data_moniker_pb2.global___BeginMonikerSidebandStreamResponse

class ni.datamonikers.v1.data_moniker_pb2.MonikerWriteRequest(*, monikers=..., data=...)

Bases: google.protobuf.message.Message

Request message used to perform streaming writes.

Parameters:

monikers (global___MonikerList | None)
data (global___MonikerValues | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MONIKERS_FIELD_NUMBER: int

DATA_FIELD_NUMBER: int

property monikers: global___MonikerList

Initial handshake message that declares the target monikers.

Return type:: global___MonikerList

property data: global___MonikerValues

Value payload for the established write session.

This field should be set on all subsequent messages after the initial handshake message.

Return type:: global___MonikerValues

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

WhichOneof(oneof_group)

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

ni.datamonikers.v1.data_moniker_pb2.global___MonikerWriteRequest

class ni.datamonikers.v1.data_moniker_pb2.MonikerReadResult(*, data=...)

Bases: google.protobuf.message.Message

Response message used to perform streaming reads.

Parameters:: data (global___MonikerValues | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

DATA_FIELD_NUMBER: int

property data: global___MonikerValues

Data values returned from the read monikers.

Return type:: global___MonikerValues

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.datamonikers.v1.data_moniker_pb2.global___MonikerReadResult

class ni.datamonikers.v1.data_moniker_pb2.StreamWriteResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ni.datamonikers.v1.data_moniker_pb2.global___StreamWriteResponse

class ni.datamonikers.v1.data_moniker_pb2.ReadFromMonikerResult(*, value=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: value (google.protobuf.any_pb2.Any | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

VALUE_FIELD_NUMBER: int

property value: google.protobuf.any_pb2.Any

Data value read from the moniker or empty if no value was available.

Return type:: google.protobuf.any_pb2.Any

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.datamonikers.v1.data_moniker_pb2.global___ReadFromMonikerResult

class ni.datamonikers.v1.data_moniker_pb2.WriteToMonikerRequest(*, moniker=..., value=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

moniker (global___Moniker | None)
value (google.protobuf.any_pb2.Any | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MONIKER_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

property moniker: global___Moniker

The data moniker to update.

Return type:: global___Moniker

property value: google.protobuf.any_pb2.Any

The data value to write to the moniker.

Return type:: google.protobuf.any_pb2.Any

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.datamonikers.v1.data_moniker_pb2.global___WriteToMonikerRequest

class ni.datamonikers.v1.data_moniker_pb2.WriteToMonikerResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ni.datamonikers.v1.data_moniker_pb2.global___WriteToMonikerResponse