NetworkExtension#

Extension for communications external to a computation graph.

  • UUID: f50665e5-ade2-f71b-de2a-2380614b1725

  • Version: 1.6.0

  • Author: NVIDIA

  • License: LICENSE

Interfaces#

nvidia::gxf::TcpCodelet#

Interface for a codelet for either end of a TCP connection.

  • Component ID: 620c572c-f03d-11ed-8a22-8f9adbb0e784

  • Base Type: nvidia::gxf::Codelet

Components#

nvidia::gxf::ClockSyncPrimary#

Publishes application clock timestamp for use by other apps.

  • Component ID: a61832d1-b0f9-42b3-97b2-ccec0e864e61

  • Base Type: nvidia::gxf::Codelet

Parameters#

tx_timestamp

The outgoing timestamp channel.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Transmitter

clock

Handle to application’s clock component.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Clock

nvidia::gxf::ClockSyncSecondary#

Advances application SyntheticClock to received timestamp.

  • Component ID: e84945fa-8630-4516-f7ce-7df2b05947c7

  • Base Type: nvidia::gxf::Codelet

Parameters#

rx_timestamp

The incoming timestamp channel.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Receiver

clock

Handle to application’s synthetic clock component.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::SyntheticClock

nvidia::gxf::TcpClient#

Codelet that functions as a client in a TCP connection.

  • Component ID: 9d5955c7-8fda-22c7-f18f-ea5e2d195be9

  • Base Type: nvidia::gxf::Codelet

Parameters#

receivers

List of receivers to receive entities from”.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Receiver


transmitters

List of transmitters to publish entities to.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Transmitter


entity_serializer

Serializer for serializing entities.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::EntitySerializer


address

Address for TCP connection.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_STRING


port

Port for TCP connection.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_INT32


timeout_ms

Time in milliseconds to wait before retrying connection. Deprecated - use timeout_period instead.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64


timeout_period

Time to wait before retrying connection. The period is specified as a string containing a number and an (optional) unit. If no unit is given the value is assumed to be in nanoseconds. Supported units are: Hz, s, ms. Example: 10ms, 10000000, 0.2s, 50Hz.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_STRING

  • Default: 100ms


maximum_attempts

Maximum number of attempts for I/O operations before failing.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 10


async_scheduling_term

Schedules execution when TCP socket or receivers have a message.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::AsynchronousSchedulingTerm


max_msg_delay_ms

Time in milliseconds to wait between messages before ending connection. Helpful for debugging.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_INT64


max_duration_ms

The maximum duration for which the component will run (in ms). If not specified the component will run indefinitely, unless another termination condition is specified. Helpful for debugging.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_INT64


max_connection_attempts

The maximum number of times the component will attempt to reconnect. If not specified the component will attempt reconnection indefinitely, unless another termination condition is specified. Helpful for debugging.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64

nvidia::gxf::TcpServer#

Codelet that functions as a server in a TCP connection.

  • Component ID: a3e0e42d-e32e-73ab-ef83-fbb311310759

  • Base Type: nvidia::gxf::Codelet

Parameters#

receivers

List of receivers to receive entities from”.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Receiver


transmitters

List of transmitters to publish entities to.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::Transmitter


entity_serializer

Serializer for serializing entities.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::EntitySerializer


address

Address for TCP connection.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_STRING


port

Port for TCP connection.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_INT32


timeout_ms

Time in milliseconds to wait before retrying connection. Deprecated - use timeout_period instead.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64


timeout_period

Time to wait before retrying connection. The period is specified as a string containing a number and an (optional) unit. If no unit is given the value is assumed to be in nanoseconds. Supported units are: Hz, s, ms. Example: 10ms, 10000000, 0.2s, 50Hz.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_STRING

  • Default: 100ms


maximum_attempts

Maximum number of attempts for I/O operations before failing.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_UINT64

  • Default: 10


async_scheduling_term

Schedules execution when TCP socket or receivers have a message.

  • Flags: GXF_PARAMETER_FLAGS_NONE

  • Type: GXF_PARAMETER_TYPE_HANDLE

  • Handle Type: nvidia::gxf::AsynchronousSchedulingTerm


max_msg_delay_ms

Time in milliseconds to wait between messages before ending connection. Helpful for debugging.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_INT64


max_duration_ms

The maximum duration for which the component will run (in ms). If not specified the component will run indefinitely, unless another termination condition is specified. Helpful for debugging.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_INT64


max_connection_attempts

The maximum number of times the component will attempt to reconnect. If not specified the component will attempt reconnection indefinitely, unless another termination condition is specified. Helpful for debugging.

  • Flags: GXF_PARAMETER_FLAGS_OPTIONAL

  • Type: GXF_PARAMETER_TYPE_UINT64