path: root/doc/modules/udp.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Melisma modules</title>
    <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<p><a href="/melisma-modules">Back to repository</a></p>
<br/>
<h1>Melisma modules</h1>


<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Class_sockaddr">Class sockaddr </a></li>
<li><a href="#Class_socket">Class socket </a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/biquad.html">biquad</a></li>
  <li><a href="../modules/expression.html">expression</a></li>
  <li><a href="../modules/fs.html">fs</a></li>
  <li><a href="../modules/keycallback.html">keycallback</a></li>
  <li><strong>udp</strong></li>
</ul>
<h2>Classes</h2>
<ul class="nowrap">
  <li><a href="../classes/buffer.html">buffer</a></li>
  <li><a href="../classes/delay.html">delay</a></li>
  <li><a href="../classes/gain.html">gain</a></li>
  <li><a href="../classes/interp.html">interp</a></li>
  <li><a href="../classes/ladspa.html">ladspa</a></li>
  <li><a href="../classes/mixer.html">mixer</a></li>
  <li><a href="../classes/nullsink.html">nullsink</a></li>
  <li><a href="../classes/oscil.html">oscil</a></li>
  <li><a href="../classes/pan.html">pan</a></li>
  <li><a href="../classes/playback.html">playback</a></li>
  <li><a href="../classes/sample.html">sample</a></li>
  <li><a href="../classes/serial.html">serial</a></li>
  <li><a href="../classes/timer.html">timer</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>udp</code></h1>
<p>UDP support.</p>
<p>



<pre>
<span class="keyword">local</span> mudp = <span class="global">require</span> <span class="string">'melisma.udp'</span>

<span class="keyword">local</span> addr = mudp.sockaddr.<span class="function-name">inet</span>(<span class="string">'127.0.0.1'</span>,<span class="number">8000</span>)
<span class="keyword">local</span> sock = mudp.socket.<span class="function-name">inet</span>()

sock:<span class="function-name">send</span>(addr,<span class="string">'hello'</span>)
sock:<span class="function-name">bind</span>(addr,<span class="global">print</span>)
</pre>

</p>


<h2><a href="#Class_sockaddr">Class sockaddr </a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#sockaddr.inet">sockaddr.inet(host, port)</a></td>
	<td class="summary">Create a internet domain address description.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#sockaddr.unix">sockaddr.unix(path)</a></td>
	<td class="summary">Create a unix domain address description.</td>
	</tr>
</table>
<h2><a href="#Class_socket">Class socket </a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#socket.inet">socket.inet()</a></td>
	<td class="summary">Create an internet domain socket.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#socket.unix">socket.unix()</a></td>
	<td class="summary">Create a unix domain socket.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#socket:bind">socket:bind(addr, fn)</a></td>
	<td class="summary">Bind a socket to an address.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#socket:send">socket:send(addr, pkt)</a></td>
	<td class="summary">Send a packet on a socket.</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header has-description"><a name="Class_sockaddr"></a>Class sockaddr </h2>

          <div class="section-description">
          Socket address description.
          </div>
    <dl class="function">
    <dt>
    <a name = "sockaddr.inet"></a>
    <strong>sockaddr.inet(host, port)</strong>
    </dt>
    <dd>
    Create a internet domain address description.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">host</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>



        </li>
        <li><span class="parameter">port</span>
            <span class="types"><span class="type">integer</span></span>



        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="../modules/udp.html#sockaddr">sockaddr</a></span>



    </ol>




</dd>
    <dt>
    <a name = "sockaddr.unix"></a>
    <strong>sockaddr.unix(path)</strong>
    </dt>
    <dd>
    Create a unix domain address description.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">path</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>



        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="../modules/udp.html#sockaddr">sockaddr</a></span>



    </ol>




</dd>
</dl>
    <h2 class="section-header has-description"><a name="Class_socket"></a>Class socket </h2>

          <div class="section-description">
          Handle to a socket.
          </div>
    <dl class="function">
    <dt>
    <a name = "socket.inet"></a>
    <strong>socket.inet()</strong>
    </dt>
    <dd>
    Create an internet domain socket.



    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="../modules/udp.html#socket">socket</a></span>



    </ol>




</dd>
    <dt>
    <a name = "socket.unix"></a>
    <strong>socket.unix()</strong>
    </dt>
    <dd>
    Create a unix domain socket.



    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="../modules/udp.html#socket">socket</a></span>



    </ol>




</dd>
    <dt>
    <a name = "socket:bind"></a>
    <strong>socket:bind(addr, fn)</strong>
    </dt>
    <dd>
    Bind a socket to an address.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">addr</span>
            <span class="types"><a class="type" href="../modules/udp.html#sockaddr">sockaddr</a></span>
         Address description.
        </li>
        <li><span class="parameter">fn</span>
            <span class="types"><span class="type">function</span></span>
         Packet callback function.
        </li>
    </ul>





</dd>
    <dt>
    <a name = "socket:send"></a>
    <strong>socket:send(addr, pkt)</strong>
    </dt>
    <dd>
    Send a packet on a socket.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">addr</span>
            <span class="types"><a class="type" href="../modules/udp.html#sockaddr">sockaddr</a></span>
         Address description.
        </li>
        <li><span class="parameter">pkt</span>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
         Packet to send.
        </li>
    </ul>





</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 1980-01-01 00:00:00 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>