> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/holoscan/sdk-user-guide/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/holoscan/sdk-user-guide/_mcp/server.

# holoscan::NetworkContext

> Base class for all network contexts.

Base class for all network contexts.

This class is the base class for all network contexts (e.g. [`holoscan::UcxContext`](ucxcontext)). It is used to define the common interface for all network contexts.

```cpp showLineNumbers={false}
#include <holoscan/network_context.hpp>
```

**Inherits from:** `holoscan::Component` (public)

***

## Constructors

### NetworkContext \[#networkcontext]

```cpp showLineNumbers={false}
holoscan::NetworkContext::NetworkContext() = default
```

```cpp showLineNumbers={false}
holoscan::NetworkContext::NetworkContext(
    NetworkContext &&
) = default
```

inline

explicit

```cpp showLineNumbers={false}
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>>)>>
holoscan::NetworkContext::NetworkContext(
    ArgT &&arg,
    ArgsT &&... args
)
```

Construct a new `NetworkContext` object.

### Destructor \[#destructor]

### \~NetworkContext

```cpp showLineNumbers={false}
holoscan::NetworkContext::~NetworkContext() override = default
```

***

## Methods

### id \[#id]

```cpp showLineNumbers={false}
NetworkContext & holoscan::NetworkContext::id(
    int64_t id
)
```

Set the `NetworkContext` ID.

**Returns:** The reference to this network context.

**Parameters**

The ID of the network context.

const

```cpp showLineNumbers={false}
int64_t holoscan::ComponentBase::id() const
```

Get the identifier of the component.

By default, the identifier is set to -1. It is set to a valid value when the component is initialized.

With the default executor (GXFExecutor), the identifier is set to the GXF component ID.

**Returns:** The identifier of the component.

### name \[#name]

```cpp showLineNumbers={false}
NetworkContext & holoscan::NetworkContext::name(
    const std::string &name
) &
```

Set the name of the network context.

**Returns:** The reference to the network context.

**Parameters**

The name of the network context.

```cpp showLineNumbers={false}
NetworkContext && holoscan::NetworkContext::name(
    const std::string &name
) &&
```

Set the name of the network context.

**Returns:** The reference to the network context.

**Parameters**

The name of the network context.

const

```cpp showLineNumbers={false}
const std::string & holoscan::ComponentBase::name() const
```

Get the name of the component.

**Returns:** The name of the component.

### fragment \[#fragment]

```cpp showLineNumbers={false}
NetworkContext & holoscan::NetworkContext::fragment(
    Fragment *fragment
)
```

Set the fragment of the network context.

**Returns:** The reference to the network context.

**Parameters**

The pointer to the fragment of the network context.

```cpp showLineNumbers={false}
Fragment * holoscan::ComponentBase::fragment()
```

Get a pointer to [Fragment](fragment) object.

**Returns:** The Pointer to [Fragment](fragment) object.

const

```cpp showLineNumbers={false}
const Fragment * holoscan::ComponentBase::fragment() const
```

Get a const pointer to [Fragment](fragment) object.

**Returns:** The const pointer to [Fragment](fragment) object.

### spec \[#spec]

```cpp showLineNumbers={false}
NetworkContext & holoscan::NetworkContext::spec(
    const std::shared_ptr<ComponentSpec> &spec
)
```

Set the component specification to the network context.

**Returns:** The reference to the network context.

**Parameters**

The component specification.

```cpp showLineNumbers={false}
ComponentSpec * holoscan::NetworkContext::spec()
```

Get the component specification of the network context.

**Returns:** The pointer to the component specification.

### spec\_shared \[#specshared]

```cpp showLineNumbers={false}
std::shared_ptr<ComponentSpec> holoscan::NetworkContext::spec_shared()
```

Get the shared pointer to the component spec.

**Returns:** The shared pointer to the component spec.

### add\_arg \[#addarg]

```cpp showLineNumbers={false}
void holoscan::NetworkContext::add_arg(
    const std::shared_ptr<Resource> &arg
)
```

Add a resource to the network context.

**Parameters**

The resource to add.

```cpp showLineNumbers={false}
void holoscan::NetworkContext::add_arg(
    std::shared_ptr<Resource> &&arg
)
```

Add a resource to the network context.

**Parameters**

The resource to add.

```cpp showLineNumbers={false}
void holoscan::ComponentBase::add_arg(
    const Arg &arg
)
```

Add an argument to the component.

**Parameters**

The argument to add.

```cpp showLineNumbers={false}
void holoscan::ComponentBase::add_arg(
    Arg &&arg
)
```

Add an argument to the component.

**Parameters**

The argument to add.

```cpp showLineNumbers={false}
void holoscan::ComponentBase::add_arg(
    const ArgList &arg
)
```

Add a list of arguments to the component.

**Parameters**

The list of arguments to add.

```cpp showLineNumbers={false}
void holoscan::ComponentBase::add_arg(
    ArgList &&arg
)
```

Add a list of arguments to the component.

**Parameters**

The list of arguments to add.

### resources \[#resources]

```cpp showLineNumbers={false}
std::unordered_map<std::string, std::shared_ptr<Resource>> & holoscan::NetworkContext::resources()
```

Get the resources of the network context.

**Returns:** The resources of the network context.

### clock \[#clock]

```cpp showLineNumbers={false}
virtual std::shared_ptr<Clock> holoscan::NetworkContext::clock()
```

Get the [Clock](clock) used by the network context.

**Returns:** The [Clock](clock) used by the network context, or nullptr if not applicable.

### setup \[#setup]

```cpp showLineNumbers={false}
virtual void holoscan::NetworkContext::setup(
    ComponentSpec &spec
)
```

Define the network context specification.

**Parameters**

The reference to the component specification.

### initialize \[#initialize]

```cpp showLineNumbers={false}
void holoscan::NetworkContext::initialize() override
```

Initialize the network context.

This function is called after the network context is created by holoscan::Fragment::make\_network\_context().

### to\_yaml\_node \[#toyamlnode]

```cpp showLineNumbers={false}
YAML::Node holoscan::NetworkContext::to_yaml_node() const override
```

Get a `YAML` representation of the network context.

**Returns:** `YAML` node including the base component properties, component spec and resources.

### reset\_backend\_objects \[#resetbackendobjects]

```cpp showLineNumbers={false}
void holoscan::NetworkContext::reset_backend_objects() override
```

Reset any backend-specific objects.

### set\_parameters \[#setparameters]

```cpp showLineNumbers={false}
virtual void holoscan::NetworkContext::set_parameters()
```

Set the parameters based on defaults (sets GXF parameters for GXF operators).

### args \[#args]

```cpp showLineNumbers={false}
std::vector<Arg> & holoscan::ComponentBase::args()
```

Get the list of arguments.

**Returns:** The vector of arguments.

### description \[#description]

```cpp showLineNumbers={false}
std::string holoscan::ComponentBase::description() const
```

Get a description of the component.

**Returns:** `YAML` string.

**See also:**
to\_yaml\_node()

### service \[#service]

```cpp showLineNumbers={false}
template <typename ServiceT = DefaultFragmentService>
std::shared_ptr<ServiceT> holoscan::ComponentBase::service(
    std::string_view id = ""
) const
```

Retrieve a registered fragment service or resource.

Retrieves a previously registered fragment service or resource by its type and optional identifier. Returns nullptr if no service/resource is found with the specified type and identifier.

Note that any changes to the service retrieval logic in this method should be synchronized with the implementation in `Fragment::service()` method to maintain consistency.

**Returns:** The shared pointer to the service/resource, or nullptr if not found or if type casting fails.

**Template parameters**

The type of the service/resource to retrieve. Must inherit from either [Resource](resource) or [FragmentService](fragmentservice). Defaults to [DefaultFragmentService](defaultfragmentservice) if not specified.

**Parameters**

The identifier of the service/resource. If empty, retrieves by type only.

### get\_service\_by\_type\_info \[#getservicebytypeinfo]

```cpp showLineNumbers={false}
std::shared_ptr<FragmentService> holoscan::ComponentBase::get_service_by_type_info(
    const std::type_info &service_type,
    std::string_view id = ""
) const
```

Retrieve a registered fragment service or resource for Python bindings.

This is a helper method for Python bindings to retrieve a service by its C++ type info.

**Returns:** The shared pointer to the base service, or nullptr if not found.

**Parameters**

The type info of the service/resource to retrieve.

The identifier of the service/resource. If empty, retrieves by type only.

### update\_params\_from\_args \[#updateparamsfromargs]

```cpp showLineNumbers={false}
void holoscan::NetworkContext::update_params_from_args()
```

Update parameters based on the specified arguments.

```cpp showLineNumbers={false}
void holoscan::ComponentBase::update_params_from_args(
    std::unordered_map<std::string, ParameterWrapper> &params
)
```

Update parameters based on the specified arguments.

### service\_provider \[#serviceprovider]

```cpp showLineNumbers={false}
void holoscan::ComponentBase::service_provider(
    FragmentServiceProvider *provider
)
```

Set the service provider that owns this component.

***

## Static methods

### register\_converter \[#registerconverter]

```cpp showLineNumbers={false}
template <typename typeT>
static void holoscan::ComponentBase::register_converter()
```

Register the argument setter for the given type.

If an operator or resource has an argument with a custom type, the argument setter must be registered using this method.

The argument setter is used to set the value of the argument from the `YAML` configuration.

This method can be called in the initialization phase of the operator/resource (e.g., `initialize()`). The example below shows how to register the argument setter for the custom type (`Vec3`):

It is assumed that `YAML::convert<T>::encode` and `YAML::convert<T>::decode` are implemented for the given type. You need to specialize the `YAML::convert<>` template class.

For example, suppose that you had a `Vec3` class with the following members:

You can define the `YAML::convert<Vec3>` as follows in a '.cpp' file:

Please refer to the [yaml-cpp documentation](https://github.com/jbeder/yaml-cpp/wiki/Tutorial#converting-tofrom-native-data-types) for more details.

**Template parameters**

The type of the argument to register.

**Example**

```cpp showLineNumbers={false}
void MyOp::initialize() {
  register_converter<Vec3>();
}
```

**Example**

```cpp showLineNumbers={false}
struct Vec3 {
  // make sure you have overloaded operator==() for the comparison
  double x, y, z;
};
```

**Example**

```cpp showLineNumbers={false}
namespace YAML {
template<>
struct convert<Vec3> {
  static Node encode(const Vec3& rhs) {
    Node node;
    node.push_back(rhs.x);
    node.push_back(rhs.y);
    node.push_back(rhs.z);
    return node;
  }

  static bool decode(const Node& node, Vec3& rhs) {
    if(!node.IsSequence() || node.size() != 3) {
      return false;
    }

    rhs.x = node[0].as<double>();
    rhs.y = node[1].as<double>();
    rhs.z = node[2].as<double>();
    return true;
  }
};
}
```

### register\_argument\_setter \[#registerargumentsetter]

```cpp showLineNumbers={false}
template <typename typeT>
void holoscan::ComponentBase::register_argument_setter()
```

Register the argument setter for the given type.

Please refer to the documentation of `register_converter()` for more details.

**Template parameters**

The type of the argument to register.

***

## Member variables

| Name                | Type                                                             | Description                                       |
| ------------------- | ---------------------------------------------------------------- | ------------------------------------------------- |
| `resources_`        | `std::unordered_map< std::string, std::shared_ptr< Resource > >` | The resources used by the network context.        |
| `spec_`             | `std::shared_ptr< ComponentSpec >`                               | The component specification.                      |
| `id_`               | `int64_t`                                                        | The ID of the component.                          |
| `name_`             | `std::string`                                                    | Name of the component.                            |
| `fragment_`         | `Fragment *`                                                     | Pointer to the fragment that owns this component. |
| `args_`             | `std::vector< Arg >`                                             | List of arguments.                                |
| `service_provider_` | `FragmentServiceProvider *`                                      | Pointer to the service provider.                  |