Skip to content

Commit 3b21d5b

Browse files
author
Documenter.jl
committed
build based on 3097115
1 parent 2dedb86 commit 3b21d5b

11 files changed

Lines changed: 25 additions & 25 deletions

File tree

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.12.5","generation_timestamp":"2026-03-18T21:50:44","documenter_version":"1.17.0"}}
1+
{"documenter":{"julia_version":"1.12.5","generation_timestamp":"2026-03-18T21:54:44","documenter_version":"1.17.0"}}

previews/PR1248/api/client/index.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

previews/PR1248/api/core/index.html

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

previews/PR1248/api/reference/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

previews/PR1248/api/server/index.html

Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

previews/PR1248/api/websockets/index.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

previews/PR1248/guides/client/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,4 +152,4 @@
152152
client_response = HTTP.request("GET", base_url * "/reused"; client = client)
153153
close(client)
154154
HTTP.forceclose(server)
155-
(status = client_response.status, body = String(client_response.body))</code></pre><p>Important <code>Client</code> and <code>Transport</code> knobs:</p><ul><li><code>prefer_http2 = true</code> to prefer ALPN-negotiated HTTP/2 for secure traffic</li><li>connection-pool sizing via <code>max_idle_per_host</code> and <code>max_idle_total</code></li><li>shared <code>CookieJar</code> state across related requests</li><li>explicit proxy routing with <code>ProxyConfig</code>, <code>ProxyURL</code>, <code>ProxyFromEnvironment</code>, and <code>NoProxy</code></li></ul><h2 id="Request-and-Response-Bodies"><a class="docs-heading-anchor" href="#Request-and-Response-Bodies">Request and Response Bodies</a><a id="Request-and-Response-Bodies-1"></a><a class="docs-heading-anchor-permalink" href="#Request-and-Response-Bodies" title="Permalink"></a></h2><p>The top-level request helpers buffer response bodies into <code>Vector{UInt8}</code> by default. Lower-level APIs such as <code>HTTP.open</code>, <code>roundtrip!</code>, and stream/server internals expose explicit body types instead.</p><p>Common body-related types:</p><ul><li><code>BytesBody</code> for already-buffered data</li><li><code>FixedLengthBody</code>, <code>ChunkedBody</code>, and <code>ManagedBody</code> for streamed bodies</li><li><code>EmptyBody</code> for requests or responses with no payload</li><li><code>Form</code> when you need a multipart/form-data request body</li></ul><h2 id="Retries,-Timeouts,-and-Tracing"><a class="docs-heading-anchor" href="#Retries,-Timeouts,-and-Tracing">Retries, Timeouts, and Tracing</a><a id="Retries,-Timeouts,-and-Tracing-1"></a><a class="docs-heading-anchor-permalink" href="#Retries,-Timeouts,-and-Tracing" title="Permalink"></a></h2><p>The retry path is explicit and conservative. For predictable behavior, prefer a long-lived <code>Client</code> over relying solely on default top-level behavior.</p><p>Reach for these APIs when you need more control:</p><ul><li><code>RetryBucket</code> for coordinated retry throttling</li><li><code>ClientTrace</code> for request lifecycle callbacks</li><li><code>connect_timeout</code> and <code>readtimeout</code> keywords on <code>request</code></li><li><code>retry_if</code>, <code>retry_non_idempotent</code>, and <code>respect_retry_after</code> for custom retry policy</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../server/">Server »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Wednesday 18 March 2026 21:50">Wednesday 18 March 2026</span>. Using Julia version 1.12.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
155+
(status = client_response.status, body = String(client_response.body))</code></pre><p>Important <code>Client</code> and <code>Transport</code> knobs:</p><ul><li><code>prefer_http2 = true</code> to prefer ALPN-negotiated HTTP/2 for secure traffic</li><li>connection-pool sizing via <code>max_idle_per_host</code> and <code>max_idle_total</code></li><li>shared <code>CookieJar</code> state across related requests</li><li>explicit proxy routing with <code>ProxyConfig</code>, <code>ProxyURL</code>, <code>ProxyFromEnvironment</code>, and <code>NoProxy</code></li></ul><h2 id="Request-and-Response-Bodies"><a class="docs-heading-anchor" href="#Request-and-Response-Bodies">Request and Response Bodies</a><a id="Request-and-Response-Bodies-1"></a><a class="docs-heading-anchor-permalink" href="#Request-and-Response-Bodies" title="Permalink"></a></h2><p>The top-level request helpers buffer response bodies into <code>Vector{UInt8}</code> by default. Lower-level APIs such as <code>HTTP.open</code>, <code>roundtrip!</code>, and stream/server internals expose explicit body types instead.</p><p>Common body-related types:</p><ul><li><code>BytesBody</code> for already-buffered data</li><li><code>FixedLengthBody</code>, <code>ChunkedBody</code>, and <code>ManagedBody</code> for streamed bodies</li><li><code>EmptyBody</code> for requests or responses with no payload</li><li><code>Form</code> when you need a multipart/form-data request body</li></ul><h2 id="Retries,-Timeouts,-and-Tracing"><a class="docs-heading-anchor" href="#Retries,-Timeouts,-and-Tracing">Retries, Timeouts, and Tracing</a><a id="Retries,-Timeouts,-and-Tracing-1"></a><a class="docs-heading-anchor-permalink" href="#Retries,-Timeouts,-and-Tracing" title="Permalink"></a></h2><p>The retry path is explicit and conservative. For predictable behavior, prefer a long-lived <code>Client</code> over relying solely on default top-level behavior.</p><p>Reach for these APIs when you need more control:</p><ul><li><code>RetryBucket</code> for coordinated retry throttling</li><li><code>ClientTrace</code> for request lifecycle callbacks</li><li><code>connect_timeout</code> and <code>readtimeout</code> keywords on <code>request</code></li><li><code>retry_if</code>, <code>retry_non_idempotent</code>, and <code>respect_retry_after</code> for custom retry policy</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../server/">Server »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Wednesday 18 March 2026 21:54">Wednesday 18 March 2026</span>. Using Julia version 1.12.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)