Skip to content

NI SCOPE Peer To Peer Streaming Attributes

ni-siray edited this page May 7, 2021 · 2 revisions

Peer To Peer Streaming Attributes

NISCOPE_ATTRIBUTE_P2P_ENABLED

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
Boolean R/W Endpoint None None

Description

Specifies whether the digitizer writes data to the peer-to-peer endpoint.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.
Default Value: FALSE

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_CHANNELS_TO_STREAM

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
String R/W Endpoint None None

Description

Specifies which channels are written to a peer-to-peer endpoint. If multiple channels are specified, the channels are interleaved by sample.

!Note Note  This attribute can only be used with high-speed digitizers that support peer-to-peer streaming.
!Note Note  This attribute must either be unused or set to all enabled channels on NI 5160/5162 digitizers.
Default Value: 0

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_ENDPOINT_SIZE

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt32 RO Endpoint None None

Description

Returns the size in samples of the peer-to-peer endpoint.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_SAMPLES_AVAIL_IN_ENDPOINT

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt32 RO Endpoint None None

Description

Returns the current number of samples available to stream from a peer-to-peer endpoint.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_MOST_SAMPLES_AVAIL_IN_ENDPOINT

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt32 RO Endpoint None None

Description

Returns the most number of samples available to stream from a peer-to-peer endpoint since the last time this attribute was read.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_SAMPLES_TRANSFERRED

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt64 RO Endpoint None None

Description

Returns the number of samples transferred through the peer-to-peer endpoint since it was last reset.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_ENDPOINT_OVERFLOW

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
Boolean RO Endpoint None None

Description

Returns TRUE if the endpoint FIFO has overflowed. Reset the endpoint to clear the overflow condition.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.


NISCOPE_ATTRIBUTE_P2P_FIFO_ENDPOINT_COUNT

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt32 RO N/A None None

Description

Returns the number of FIFO-based peer-to-peer endpoints this device supports.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_ONBOARD_MEMORY_ENABLED

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
Boolean R/W N/A None None

Description

Specifies whether the digitizer writes data to onboard memory when a peer-to-peer endpoint is enabled.

!Note Note  This attribute can only be used with high-speed digitizers that support peer-to-peer streaming.
!Note Note  This attribute is not supported on NI 5160/5162 digitizers.

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_STREAM_RELATIVE_TO

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt32 RW Endpoint None None

Description

Determines which trigger peer-to-peer data is streamed relative to.

!Note Note  On the NI 5122/5622, only NISCOPE_VAL_STREAM_RELATIVE_TO_START_TRIGGER is valid for this attribute.
Default Value: NISCOPE_VAL_STREAM_RELATIVE_TO_START_TRIGGER (0)

Defined Values

NISCOPE_VAL_STREAM_RELATIVE_TO_START_TRIGGER (0)

NISCOPE_VAL_STREAM_RELATIVE_TO_REFERENCE_TRIGGER (1)

NISCOPE_VAL_STREAM_RELATIVE_TO_SYNC_TRIGGER (2)

NISCOPE_ATTRIBUTE_P2P_SAMPLES_TRANSFERRED_PER_RECORD

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt32 RO Endpoint None None

Description

Returns the number of samples transferred per record when you set the NISCOPE_ATTRIBUTE_P2P_STREAM_RELATIVE_TO attribute to NISCOPE_VAL_STREAM_RELATIVE_TO_REFERENCE_TRIGGER or NISCOPE_VAL_STREAM_RELATIVE_TO_SYNC_TRIGGER.

!Note Note  This attribute is only supported on NI 5160/5162 digitizers.


NISCOPE_ATTRIBUTE_P2P_MANUAL_CONFIGURATION_ENABLED

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
Boolean R/W Endpoint None None

Description

Enables/disables the advanced attributes for a peer-to-peer endpoint. These attributes cannot be used if an endpoint is being configured by NI-P2P, or a resource reservation error will occur.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_DATA_TRANS_PERMISSION_ADDR

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt64 RO Endpoint None None

Description

Returns the address of a hardware register used to grant permission for the peer-to-peer endpoint to write data to another peer. The type of this address is determined by the NISCOPE_ATTRIBUTE_P2P_DATA_TRANS_PERMISSION_ADDR_TYPE attribute. Permission is granted in bytes and the register is additive.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_DATA_TRANS_PERMISSION_ADDR_TYPE

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt32 R/W Endpoint None None

Description

Specifies the type of address returned from the NISCOPE_ATTRIBUTE_P2P_DATA_TRANS_PERMISSION_ADDR attribute.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.
Default Value: NISCOPE_VAL_ADDR_VIRTUAL

Defined Values

NISCOPE_VAL_ADDR_PHYSICAL (0)

NISCOPE_VAL_ADDR_VIRTUAL (1)

NISCOPE_ATTRIBUTE_P2P_DESTINATION_WINDOW_ADDR

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt64 R/W Endpoint None None

Description

Specifies the destination for data written by the peer-to-peer endpoint. The type of this address is specified by the NISCOPE_ATTRIBUTE_P2P_DESTINATION_WINDOW_ADDR_TYPE attribute.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.

Valid Values

A valid, non-NULL physical or virtual address.

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_DESTINATION_WINDOW_ADDR_TYPE

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt32 R/W Endpoint None None

Description

Specifies the type of the NISCOPE_ATTRIBUTE_P2P_DESTINATION_WINDOW_ADDR attribute.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.
Default Value: NISCOPE_VAL_ADDR_VIRTUAL

Defined Values

NISCOPE_VAL_ADDR_PHYSICAL (0)

NISCOPE_VAL_ADDR_VIRTUAL (1)

NISCOPE_ATTRIBUTE_P2P_DESTINATION_WINDOW_SIZE

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt64 R/W Endpoint None None

Description

Specifies the size, in bytes, of the destination window determined by the NISCOPE_ATTRIBUTE_P2P_DESTINATION_WINDOW_ADDR and the NISCOPE_ATTRIBUTE_P2P_DESTINATION_WINDOW_ADDR_TYPE attributes.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.

Valid Values

Any non-NULL value.

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_NOTIFY_PUSH_MESSAGE_ON

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt32 R/W Endpoint None None

Description

Specifies the event to push the NISCOPE_ATTRIBUTE_P2P_NOTIFY_MESSAGE_PUSH_VALUE attribute to the NISCOPE_ATTRIBUTE_P2P_NOTIFY_MESSAGE_PUSH_ADDR attribute. Setting this attribute to NISCOPE_VAL_NOTIFY_DONE pushes the message when the acquisition has completed.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.
Default Value: NISCOPE_VAL_NOTIFY_NEVER

Defined Values

NISCOPE_VAL_NOTIFY_NEVER (0)

NISCOPE_VAL_NOTIFY_DONE (1)

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_NOTIFY_MESSAGE_PUSH_ADDR

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt64 R/W Endpoint None None

Description

Specifies the address to Push Message push Value to on the event specified by the NISCOPE_ATTRIBUTE_P2P_NOTIFY_PUSH_MESSAGE_ON attribute.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.

Related topics:

  • Peer-to-Peer Streaming


NISCOPE_ATTRIBUTE_P2P_NOTIFY_MESSAGE_PUSH_ADDR_TYPE

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt32 R/W Endpoint None None

Description

Specifies the type of the NISCOPE_ATTRIBUTE_P2P_NOTIFY_MESSAGE_PUSH_ADDR attribute.

!Note Note  This attribute can be used only with high-speed digitizers that support peer-to-peer streaming.
Default Value: NISCOPE_VAL_ADDR_VIRTUAL

Defined Values

NISCOPE_VAL_ADDR_PHYSICAL (0)

NISCOPE_VAL_ADDR_VIRTUAL (1)

NISCOPE_ATTRIBUTE_P2P_NOTIFY_MESSAGE_PUSH_VALUE

Specific Attribute

Data
type
Access Applies to Coercion High Level Functions
ViInt64 R/W Endpoint None None

Description

Specifies the value to be pushed to the NISCOPE_ATTRIBUTE_P2P_NOTIFY_MESSAGE_PUSH_ADDR attribute on the event specified by the NISCOPE_ATTRIBUTE_P2P_NOTIFY_PUSH_MESSAGE_ON attribute.

!Note Note  This attribute is only supported by devices that support peer-to-peer streaming.

Related topics:

  • Peer-to-Peer Streaming


Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally