# {py:mod}`ros_sugar.robot.transports`

```{py:module} ros_sugar.robot.transports
```

```{autodoc2-docstring} ros_sugar.robot.transports
:allowtitles:
```

## Submodules

```{toctree}
:titlesonly:
:maxdepth: 1

ros_sugar.robot.transports.http
ros_sugar.robot.transports.ros
ros_sugar.robot.transports.udp
ros_sugar.robot.transports.sdk
```

## Package Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`SubscriptionHandle <ros_sugar.robot.transports.SubscriptionHandle>`
  - ```{autodoc2-docstring} ros_sugar.robot.transports.SubscriptionHandle
    :summary:
    ```
* - {py:obj}`Transport <ros_sugar.robot.transports.Transport>`
  - ```{autodoc2-docstring} ros_sugar.robot.transports.Transport
    :summary:
    ```
````

### API

`````{py:class} SubscriptionHandle(unsubscribe: typing.Callable[[], None])
:canonical: ros_sugar.robot.transports.SubscriptionHandle

```{autodoc2-docstring} ros_sugar.robot.transports.SubscriptionHandle
```

````{py:method} unsubscribe() -> None
:canonical: ros_sugar.robot.transports.SubscriptionHandle.unsubscribe

```{autodoc2-docstring} ros_sugar.robot.transports.SubscriptionHandle.unsubscribe
```

````

`````

`````{py:class} Transport(name: str, *, keep_alive_fn: typing.Optional[typing.Callable[[], None]] = None, keep_alive_rate_hz: typing.Optional[float] = None, route_via_host: bool = False)
:canonical: ros_sugar.robot.transports.Transport

Bases: {py:obj}`abc.ABC`

```{autodoc2-docstring} ros_sugar.robot.transports.Transport
```

````{py:method} open() -> None
:canonical: ros_sugar.robot.transports.Transport.open
:abstractmethod:

```{autodoc2-docstring} ros_sugar.robot.transports.Transport.open
```

````

````{py:method} open_egress() -> None
:canonical: ros_sugar.robot.transports.Transport.open_egress

```{autodoc2-docstring} ros_sugar.robot.transports.Transport.open_egress
```

````

````{py:method} close() -> None
:canonical: ros_sugar.robot.transports.Transport.close
:abstractmethod:

```{autodoc2-docstring} ros_sugar.robot.transports.Transport.close
```

````

````{py:method} is_open() -> bool
:canonical: ros_sugar.robot.transports.Transport.is_open

```{autodoc2-docstring} ros_sugar.robot.transports.Transport.is_open
```

````

````{py:method} send(payload: typing.Any) -> bool
:canonical: ros_sugar.robot.transports.Transport.send
:abstractmethod:

```{autodoc2-docstring} ros_sugar.robot.transports.Transport.send
```

````

````{py:method} subscribe(on_msg: typing.Callable[[typing.Any], None]) -> ros_sugar.robot.transports.SubscriptionHandle
:canonical: ros_sugar.robot.transports.Transport.subscribe

```{autodoc2-docstring} ros_sugar.robot.transports.Transport.subscribe
```

````

````{py:property} kind
:canonical: ros_sugar.robot.transports.Transport.kind
:type: str

```{autodoc2-docstring} ros_sugar.robot.transports.Transport.kind
```

````

`````