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

Add more example of transport #26768

Merged
merged 5 commits into from
Oct 13, 2022
Merged

Add more example of transport #26768

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
14526a1
Add more example of transport
lmazuel Oct 11, 2022
0eb25ab
Update CLIENT_LIBRARY_DEVELOPER.md
xiangyan99 Oct 11, 2022
8441e1f
Update CLIENT_LIBRARY_DEVELOPER.md
xiangyan99 Oct 11, 2022
df6c8fa
Update CLIENT_LIBRARY_DEVELOPER.md
xiangyan99 Oct 11, 2022
24965d5
Update CLIENT_LIBRARY_DEVELOPER.md
xiangyan99 Oct 11, 2022
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
16 changes: 16 additions & 0 deletions sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,22 @@ from azure.core.pipeline.transport import RequestsTransport
synchronous_transport = RequestsTransport()
```

For example if you would like to alter connection pool you can initialise `RequestsTransport` with an instance of `requests.Session`.

```Python
import requests
from azure.core.pipeline.transport import RequestsTransport
session = requests.Session()
adapter = requests.adapters.HTTPAdapter(pool_connections=42, pool_maxsize=42)
session.mount('https://', adapter)
client = FooServiceClient(endpoint, creds, transport=RequestsTransport(session=session, session_owner=False))

# Here we want to manage the session by ourselves. When we are done with the session, we need to close the session.
session.close()

# Note: `session_owner` gives the information of ownership of the requests sessions to the transport instance, to authorize it to close on customer's behalf. If you're ok that the client closes your session on your behalf as necessary, you don't need to pass a value.
```

For asynchronous pipelines a couple of transport options are available. Each of these transports are interchangable depending on whether the user has installed various 3rd party dependencies (i.e. aiohttp or trio), and the user
should easily be able to specify their chosen transport. SDK developers should use the `aiohttp` transport as the default for asynchronous pipelines where the user has not specified an alternative.

Expand Down