Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the UDS section from docs #1009

Merged
merged 1 commit into from
May 30, 2020
Merged

Remove the UDS section from docs #1009

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions docs/async.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,20 +182,3 @@ async with httpx.AsyncClient(transport=transport, base_url="http://testserver")
```

See [the ASGI documentation](https://asgi.readthedocs.io/en/latest/specs/www.html#connection-scope) for more details on the `client` and `root_path` keys.

## Unix Domain Sockets

The async client provides support for connecting through a unix domain socket via the `uds` parameter. This is useful when making requests to a server that is bound to a socket file rather than an IP address.

Here's an example requesting the Docker Engine API:

```python
import httpx


async with httpx.AsyncClient(uds="/var/run/docker.sock") as client:
# This request will connect through the socket file.
resp = await client.get("http://localhost/version")
```

This functionality is not currently available in the synchronous client.