dynamo.nixl_connect.WritableOperation — NVIDIA Dynamo Documentation
Title: dynamo.nixl_connect.WritableOperation — NVIDIA Dynamo Documentation
Published Time: Tue, 14 Oct 2025 15:18:44 GMT
Markdown Content: dynamo.nixl_connect.WritableOperation#
An operation which enables a remote worker to write data to the local worker.
To create the operation, a set of local Descriptor objects must be provided which reference memory intended to receive data from a remote worker. Once created, the memory referenced by the provided descriptors becomes immediately writable by a remote worker with the necessary metadata. The NIXL metadata (RdmaMetadata) 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. Cancellation is handled asynchronously.
Example Usage#
async def recv_data(
self,
local_tensor: torch.Tensor
) -> None:
descriptor = dynamo.nixl_connect.Descriptor(local_tensor)
with self.connector.create_writable(descriptor) as write_op:
op_metadata = write_op.metadata()
# Send the metadata to the remote worker via sideband communication.
await self.request_remote_data(op_metadata)
# Wait the remote worker to complete its write operation to local_tensor.
# AKA receive data from remote worker.
await write_op.wait_for_completion()
Methods#
metadata#
def metadata(self) -> RdmaMetadata:
Generates and returns the NIXL metadata (RdmaMetadata) required for a remote worker to write to 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#
async def wait_for_completion(self) -> None:
Blocks the caller until the operation has received a completion signal from a remote worker.
Properties#
status#
@property def status(self) -> OperationStatus:
Returns OperationStatus which provides the current state (aka. status) of the operation.
Links/Buttons:
- Skip to main content
- document.write(
<img src="../../_static/nvidia-logo-horiz-rgb-wht-for-screen.svg" class="logo__image only-dark" alt="NVIDIA Dynamo Documentation - Home"/>); NVIDIA Dynamo Documentation - GitHub
- Installation
- Support Matrix
- Architecture
- Disaggregated Serving
- Examples
- Quickstart (K8s)
- Detailed Installation Guide
- Dynamo Operator
- Metrics
- Logging
- Multinode
- Minikube Setup
- Backends
- vLLM
- SGLang
- TensorRT-LLM
- Router
- Planner
- Pre-Deployment Profiling
- Load-based Planner
- SLA-based Planner
- KVBM
- Motivation
- KVBM Architecture
- Understanding KVBM components
- KVBM Further Reading
- LMCache Integration
- Dynamo Benchmarking Guide
- Planner Benchmark Example
- Health Checks
- Tuning Disaggregated Serving Performance
- Writing Python Workers in Dynamo
- Glossary
- #
- Descriptor
- RdmaMetadata
- OperationStatus
- Connector
- Device
- ReadOperation
- ReadableOperation
- WriteOperation
- Privacy Policy
- Manage My Privacy
- Do Not Sell or Share My Data
- Terms of Service
- Accessibility
- Corporate Policies
- Product Security
- Contact