Class UcxContext

Inheritance Relationships

class UcxContext : public holoscan::gxf::GXFNetworkContext

UCX-based NetworkContext class used by distributed applications.

Application authors do not need to use this class directly. It will be initialized by the application at runtime as needed.

==Parameters==

entity_serializer (std::shared_ptr<UcxEntitySerializer>): The entity serializer that will be used for any network connections (i.e. add_flow connections between fragments). A UcxEntitySerializer will be used by default.
reconnect (bool, optional): Try to reconnect if a connection is closed during run (default: true).
cpu_data_only (bool, optional): This flag should be set to true on a system which does not have any (visible) CUDA capable devices.
enable_async (bool, optional): If false, synchronous operation of message transmission will be used (Default: false). The HOLOSCAN_UCX_ASYNCHRONOUS environment variable can be used to set the value that Holoscan will use for this parameter when creating its internal UcxNetworkContext.

Public Functions

template<typename ArgT, typename ...ArgsT, typename = std::enable_if_t<!std::is_base_of_v<::holoscan::NetworkContext, std::decay_t<ArgT>> && (std::is_same_v<::holoscan::Arg, std::decay_t<ArgT>> || std::is_same_v<::holoscan::ArgList, std::decay_t<ArgT>>)>> inline explicit UcxContext(ArgT &&arg, ArgsT&&... args)

inline virtual const char *gxf_typename() const override

Get the type name of the GXF network context.

The returned string is the type name of the GXF network context and is used to create the GXF network context.

Example: “nvidia::holoscan::UcxContext”

virtual void setup(ComponentSpec &spec) override

Define the network context specification.

virtual void initialize() override

Initialize the network context.

This function is called after the network context is created by holoscan::Fragment::make_network_context().