2024-10-09 19:40:26 +00:00
2023-12-05 16:25:51 -08:00
<!DOCTYPE html>
2024-09-10 20:35:13 +00:00
< html class = "writer-html5" lang = "en" data-content_root = "../../../" >
2023-12-05 16:25:51 -08:00
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2024-10-01 22:41:44 +00:00
< title > kittycad.models.web_socket_request — kittycad v0.7.1 documentation< / title >
2024-09-10 20:35:13 +00:00
< link rel = "stylesheet" type = "text/css" href = "../../../_static/pygments.css?v=d10597a4" / >
2024-10-09 19:40:26 +00:00
< link rel = "stylesheet" type = "text/css" href = "../../../_static/css/theme.css?v=7ab3649f" / >
2024-09-10 20:35:13 +00:00
< link rel = "stylesheet" type = "text/css" href = "../../../_static/graphviz.css?v=fd3f3429" / >
< link rel = "stylesheet" type = "text/css" href = "../../../_static/copybutton.css?v=76b2166b" / >
< link rel = "stylesheet" type = "text/css" href = "../../../_static/autoclasstoc.css?v=08871587" / >
2024-10-09 19:40:26 +00:00
< script src = "../../../_static/jquery.js?v=5d32c60e" > < / script >
< script src = "../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c" > < / script >
< script src = "../../../_static/documentation_options.js?v=a1b19286" > < / script >
< script src = "../../../_static/doctools.js?v=9a2dae69" > < / script >
< script src = "../../../_static/sphinx_highlight.js?v=dc90522c" > < / script >
< script src = "../../../_static/clipboard.min.js?v=a7894cd8" > < / script >
< script src = "../../../_static/copybutton.js?v=f281be69" > < / script >
2023-12-05 16:25:51 -08:00
< script src = "../../../_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "../../../genindex.html" / >
< link rel = "search" title = "Search" href = "../../../search.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "../../../index.html" class = "icon icon-home" >
kittycad
< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../../../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" aria-label = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div > < div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "Navigation menu" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../_autosummary/kittycad.api.html" > kittycad.api< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../_autosummary/kittycad.client.html" > kittycad.client< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../_autosummary/kittycad.models.html" > kittycad.models< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../_autosummary/kittycad.types.html" > kittycad.types< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" > < nav class = "wy-nav-top" aria-label = "Mobile navigation menu" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../../../index.html" > kittycad< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "Page navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "../../../index.html" class = "icon icon-home" aria-label = "Home" > < / a > < / li >
< li class = "breadcrumb-item" > < a href = "../../index.html" > Module code< / a > < / li >
< li class = "breadcrumb-item active" > kittycad.models.web_socket_request< / li >
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< h1 > Source code for kittycad.models.web_socket_request< / h1 > < div class = "highlight" > < pre >
2024-08-20 17:43:56 +00:00
< span > < / span > < span class = "kn" > from< / span > < span class = "nn" > typing< / span > < span class = "kn" > import< / span > < span class = "n" > Dict< / span > < span class = "p" > ,< / span > < span class = "n" > List< / span > < span class = "p" > ,< / span > < span class = "n" > Literal< / span > < span class = "p" > ,< / span > < span class = "n" > Union< / span >
2023-12-05 16:25:51 -08:00
2024-07-28 22:52:47 +00:00
< span class = "kn" > from< / span > < span class = "nn" > pydantic< / span > < span class = "kn" > import< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ,< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > ,< / span > < span class = "n" > Field< / span > < span class = "p" > ,< / span > < span class = "n" > RootModel< / span >
2023-12-05 16:25:51 -08:00
< span class = "kn" > from< / span > < span class = "nn" > typing_extensions< / span > < span class = "kn" > import< / span > < span class = "n" > Annotated< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..models.client_metrics< / span > < span class = "kn" > import< / span > < span class = "n" > ClientMetrics< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..models.modeling_cmd< / span > < span class = "kn" > import< / span > < span class = "n" > ModelingCmd< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..models.modeling_cmd_id< / span > < span class = "kn" > import< / span > < span class = "n" > ModelingCmdId< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..models.modeling_cmd_req< / span > < span class = "kn" > import< / span > < span class = "n" > ModelingCmdReq< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..models.rtc_ice_candidate_init< / span > < span class = "kn" > import< / span > < span class = "n" > RtcIceCandidateInit< / span >
< span class = "kn" > from< / span > < span class = "nn" > ..models.rtc_session_description< / span > < span class = "kn" > import< / span > < span class = "n" > RtcSessionDescription< / span >
2024-09-10 22:57:44 +00:00
< div class = "viewcode-block" id = "OptionTrickleIce" >
< a class = "viewcode-back" href = "../../../_autosummary/kittycad.models.web_socket_request.OptionTrickleIce.html#kittycad.models.web_socket_request.OptionTrickleIce" > [docs]< / a >
< span class = "k" > class< / span > < span class = "nc" > OptionTrickleIce< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " The trickle ICE candidate request." " " < / span >
< span class = "n" > candidate< / span > < span class = "p" > :< / span > < span class = "n" > RtcIceCandidateInit< / span >
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " trickle_ice" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " trickle_ice" < / span >
2023-12-05 16:25:51 -08:00
2024-07-28 22:52:47 +00:00
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-12-05 16:25:51 -08:00
2024-07-28 22:52:47 +00:00
2024-09-10 22:57:44 +00:00
< div class = "viewcode-block" id = "OptionSdpOffer" >
< a class = "viewcode-back" href = "../../../_autosummary/kittycad.models.web_socket_request.OptionSdpOffer.html#kittycad.models.web_socket_request.OptionSdpOffer" > [docs]< / a >
< span class = "k" > class< / span > < span class = "nc" > OptionSdpOffer< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " The SDP offer request." " " < / span >
< span class = "n" > offer< / span > < span class = "p" > :< / span > < span class = "n" > RtcSessionDescription< / span >
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " sdp_offer" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " sdp_offer" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-12-05 16:25:51 -08:00
2024-07-28 22:52:47 +00:00
2024-09-10 22:57:44 +00:00
< div class = "viewcode-block" id = "OptionModelingCmdReq" >
< a class = "viewcode-back" href = "../../../_autosummary/kittycad.models.web_socket_request.OptionModelingCmdReq.html#kittycad.models.web_socket_request.OptionModelingCmdReq" > [docs]< / a >
< span class = "k" > class< / span > < span class = "nc" > OptionModelingCmdReq< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " The modeling command request." " " < / span >
< span class = "n" > cmd< / span > < span class = "p" > :< / span > < span class = "n" > ModelingCmd< / span >
< span class = "n" > cmd_id< / span > < span class = "p" > :< / span > < span class = "n" > ModelingCmdId< / span >
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " modeling_cmd_req" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " modeling_cmd_req" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-12-05 16:25:51 -08:00
2024-07-28 22:52:47 +00:00
2024-09-10 22:57:44 +00:00
< div class = "viewcode-block" id = "OptionModelingCmdBatchReq" >
< a class = "viewcode-back" href = "../../../_autosummary/kittycad.models.web_socket_request.OptionModelingCmdBatchReq.html#kittycad.models.web_socket_request.OptionModelingCmdBatchReq" > [docs]< / a >
< span class = "k" > class< / span > < span class = "nc" > OptionModelingCmdBatchReq< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " A sequence of modeling requests. If any request fails, following requests will not be tried." " " < / span >
2024-07-28 22:52:47 +00:00
< span class = "n" > batch_id< / span > < span class = "p" > :< / span > < span class = "n" > ModelingCmdId< / span >
2023-12-05 16:25:51 -08:00
< span class = "n" > requests< / span > < span class = "p" > :< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > ModelingCmdReq< / span > < span class = "p" > ]< / span >
2024-08-20 17:43:56 +00:00
< span class = "n" > responses< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span >
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " modeling_cmd_batch_req" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " modeling_cmd_batch_req" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-12-05 16:25:51 -08:00
2024-09-10 22:57:44 +00:00
< div class = "viewcode-block" id = "OptionPing" >
< a class = "viewcode-back" href = "../../../_autosummary/kittycad.models.web_socket_request.OptionPing.html#kittycad.models.web_socket_request.OptionPing" > [docs]< / a >
< span class = "k" > class< / span > < span class = "nc" > OptionPing< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " The client-to-server Ping to ensure the WebSocket stays alive." " " < / span >
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " ping" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " ping" < / span >
2023-12-05 16:25:51 -08:00
2024-07-28 22:52:47 +00:00
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-12-05 16:25:51 -08:00
2024-07-28 22:52:47 +00:00
2024-09-10 22:57:44 +00:00
< div class = "viewcode-block" id = "OptionMetricsResponse" >
< a class = "viewcode-back" href = "../../../_autosummary/kittycad.models.web_socket_request.OptionMetricsResponse.html#kittycad.models.web_socket_request.OptionMetricsResponse" > [docs]< / a >
< span class = "k" > class< / span > < span class = "nc" > OptionMetricsResponse< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " The response to a metrics collection request from the server." " " < / span >
< span class = "n" > metrics< / span > < span class = "p" > :< / span > < span class = "n" > ClientMetrics< / span >
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " metrics_response" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " metrics_response" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2024-09-10 22:57:44 +00:00
< div class = "viewcode-block" id = "OptionHeaders" >
< a class = "viewcode-back" href = "../../../_autosummary/kittycad.models.web_socket_request.OptionHeaders.html#kittycad.models.web_socket_request.OptionHeaders" > [docs]< / a >
< span class = "k" > class< / span > < span class = "nc" > OptionHeaders< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2024-07-28 22:52:47 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " Authentication header request." " " < / span >
< span class = "n" > headers< / span > < span class = "p" > :< / span > < span class = "n" > Dict< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "nb" > str< / span > < span class = "p" > ]< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " headers" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " headers" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-12-05 16:25:51 -08:00
< span class = "n" > WebSocketRequest< / span > < span class = "o" > =< / span > < span class = "n" > RootModel< / span > < span class = "p" > [< / span >
< span class = "n" > Annotated< / span > < span class = "p" > [< / span >
< span class = "n" > Union< / span > < span class = "p" > [< / span >
2024-09-10 22:57:44 +00:00
< span class = "n" > OptionTrickleIce< / span > < span class = "p" > ,< / span >
< span class = "n" > OptionSdpOffer< / span > < span class = "p" > ,< / span >
< span class = "n" > OptionModelingCmdReq< / span > < span class = "p" > ,< / span >
< span class = "n" > OptionModelingCmdBatchReq< / span > < span class = "p" > ,< / span >
< span class = "n" > OptionPing< / span > < span class = "p" > ,< / span >
< span class = "n" > OptionMetricsResponse< / span > < span class = "p" > ,< / span >
< span class = "n" > OptionHeaders< / span > < span class = "p" > ,< / span >
2023-12-05 16:25:51 -08:00
< span class = "p" > ],< / span >
< span class = "n" > Field< / span > < span class = "p" > (< / span > < span class = "n" > discriminator< / span > < span class = "o" > =< / span > < span class = "s2" > " type" < / span > < span class = "p" > ),< / span >
< span class = "p" > ]< / span >
< span class = "p" > ]< / span >
< / pre > < / div >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
2024-07-28 22:52:47 +00:00
< p > © Copyright 2024, KittyCAD Team Members.< / p >
2023-12-05 16:25:51 -08:00
< / div >
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
