node-red-contrib-sitx
Version:
Node-RED Nodes for sending & receiving Cursor on Target TAK Data with PAR Sit(x).
153 lines (134 loc) • 9.04 kB
HTML
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pytak.create_udp_client — PyTAK 0.1.1 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="pytak.protocol_factory" href="pytak.protocol_factory.html" />
<link rel="prev" title="pytak.CLITool" href="pytak.CLITool.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">
PyTAK
</a>
<div class="version">
0.1.1
</div>
<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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../config.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../compat.html">Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../clients.html">Clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="pytak.html">pytak</a></li>
<li class="toctree-l2"><a class="reference internal" href="pytak.Worker.html">pytak.Worker</a></li>
<li class="toctree-l2"><a class="reference internal" href="pytak.TXWorker.html">pytak.TXWorker</a></li>
<li class="toctree-l2"><a class="reference internal" href="pytak.RXWorker.html">pytak.RXWorker</a></li>
<li class="toctree-l2"><a class="reference internal" href="pytak.QueueWorker.html">pytak.QueueWorker</a></li>
<li class="toctree-l2"><a class="reference internal" href="pytak.CLITool.html">pytak.CLITool</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">pytak.create_udp_client</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pytak.create_udp_client"><code class="docutils literal notranslate"><span class="pre">create_udp_client()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pytak.protocol_factory.html">pytak.protocol_factory</a></li>
<li class="toctree-l2"><a class="reference internal" href="pytak.txworker_factory.html">pytak.txworker_factory</a></li>
<li class="toctree-l2"><a class="reference internal" href="pytak.rxworker_factory.html">pytak.rxworker_factory</a></li>
<li class="toctree-l2"><a class="reference internal" href="pytak.cli.html">pytak.cli</a></li>
<li class="toctree-l2"><a class="reference internal" href="pytak.read_pref_package.html">pytak.read_pref_package</a></li>
</ul>
</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">PyTAK</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="../api.html">API</a></li>
<li class="breadcrumb-item active">pytak.create_udp_client</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/generated/pytak.create_udp_client.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="pytak-create-udp-client">
<h1>pytak.create_udp_client<a class="headerlink" href="#pytak-create-udp-client" title="Permalink to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="pytak.create_udp_client">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pytak.</span></span><span class="sig-name descname"><span class="pre">create_udp_client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ParseResult</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iface</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_addr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">DatagramClient</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">DatagramClient</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pytak.create_udp_client" title="Permalink to this definition"></a></dt>
<dd><p>Create an AsyncIO UDP network client for Unicast, Broadcast & Multicast.</p>
<section id="parameters">
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
<dl>
<dt>url<span class="classifier"><cite>ParseResult</cite></span></dt><dd><p>A parsed fully-qualified URL parsed with <cite>urllib.parse.urlparse()</cite>.
For example: udp://tak.example.com:4242</p>
</dd>
</dl>
</section>
<section id="returns">
<h2>Returns<a class="headerlink" href="#returns" title="Permalink to this heading"></a></h2>
<dl class="simple">
<dt><cite>DatagramClient</cite></dt><dd><p>An AsyncIO UDP network stream client.</p>
</dd>
</dl>
</section>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="pytak.CLITool.html" class="btn btn-neutral float-left" title="pytak.CLITool" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="pytak.protocol_factory.html" class="btn btn-neutral float-right" title="pytak.protocol_factory" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2023 Sensors & Signals LLC.</p>
</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>