> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.nvidia.com/dynamo/latest/llms.txt. For section-specific indexes, append /llms.txt to any section URL.

# Readable Operation

An operation which enables a remote worker to read data from the local worker.

To create the operation, a set of local [`Descriptor`](/dynamo/dev/additional-resources/nixl-connect-api/descriptor) objects must be provided that reference memory intended to be transferred to a remote worker.
Once created, the memory referenced by the provided descriptors becomes immediately readable by a remote worker with the necessary metadata.
The NIXL metadata ([RdmaMetadata](/dynamo/dev/additional-resources/nixl-connect-api/rdma-metadata)) required to access the memory referenced by the provided descriptors is accessible via the operations `.metadata()` method.
Once acquired, the metadata needs to be provided to a remote worker via a secondary channel, most likely HTTP or TCP+NATS.

Disposal of the object will instruct the NIXL subsystem to cancel the operation,
therefore the operation should be awaited until completed unless cancellation is intended.


## Example Usage

```python
    async def send_data(
      self,
      local_tensor: torch.Tensor
    ) -> None:
      descriptor = dynamo.nixl_connect.Descriptor(local_tensor)

      with await self.connector.create_readable(descriptor) as read_op:
        op_metadata = read_op.metadata()

        # Send the metadata to the remote worker via sideband communication.
        await self.notify_remote_data(op_metadata)
        # Wait for the remote worker to complete its read operation of local_tensor.
        # AKA send data to remote worker.
        await read_op.wait_for_completion()
```


## Methods

### `metadata`

```python
def metadata(self) -> RdmaMetadata:
```

Generates and returns the NIXL metadata ([RdmaMetadata](/dynamo/dev/additional-resources/nixl-connect-api/rdma-metadata)) required for a remote worker to read from the operation.
Once acquired, the metadata needs to be provided to a remote worker via a secondary channel, most likely HTTP or TCP+NATS.

### `wait_for_completion`

```python
async def wait_for_completion(self) -> None:
```

Blocks the caller until the operation has received a completion signal from a remote worker.


## Properties

### `status`

```python
@property
def status(self) -> OperationStatus:
```

Returns [`OperationStatus`](/dynamo/dev/additional-resources/nixl-connect-api/operation-status) which provides the current state (aka. status) of the operation.


## Related Classes

  - [Connector](/dynamo/dev/additional-resources/nixl-connect-api/connector)
  - [Descriptor](/dynamo/dev/additional-resources/nixl-connect-api/descriptor)
  - [Device](/dynamo/dev/additional-resources/nixl-connect-api/device)
  - [OperationStatus](/dynamo/dev/additional-resources/nixl-connect-api/operation-status)
  - [RdmaMetadata](/dynamo/dev/additional-resources/nixl-connect-api/rdma-metadata)
  - [ReadOperation](/dynamo/dev/additional-resources/nixl-connect-api/read-operation)
  - [WritableOperation](/dynamo/dev/additional-resources/nixl-connect-api/writable-operation)
  - [WriteOperation](/dynamo/dev/additional-resources/nixl-connect-api/write-operation)