Packages

ldap

13.7.26
15.4.16 15.4.15 15.4.14 15.1.1 14.7.15 14.6.26 13.7.26 13.7.24 8.6.3 8.6.2 8.6.1 8.6.0

LDAP CXC 138 22 Directory Server

HexDocs

Current section

Files

Jump to
Readme
12 Versions
1 Dependency
Dependants
Files
Activity
ldap doc LDAP.html
Raw

doc/LDAP.html 

<!DOCTYPE html>

<html lang="en">

  <head>

    <meta charset="utf-8">

    <meta http-equiv="x-ua-compatible" content="ie=edge">

    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <meta name="generator" content="ExDoc v0.30.3">

    <meta name="project" content="ldap v13.7.26">



    <title>LDAP — ldap v13.7.26</title>

    <link rel="stylesheet" href="dist/html-elixir-P5GXSCHE.css" />





    <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>

    <script src="dist/handlebars.templates-NBND3S2D.js"></script>

    <script src="dist/sidebar_items-9E1A2158.js"></script>



      <script src="docs_config.js"></script>



    <script async src="dist/html-CGDDOCMI.js"></script>





  </head>

  <body data-type="modules" class="page-module">

    <script>



      try {

        var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');



        if (settings.theme === 'dark' ||

           ((settings.theme === 'system' || settings.theme == null) &&

             window.matchMedia('(prefers-color-scheme: dark)').matches)

           ) {

          document.body.classList.add('dark')

        }

      } catch (error) { }

    </script>



<div class="main">



<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">

  <i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>

</button>



<section class="sidebar">

  <form class="sidebar-search" action="search.html">

    <button type="submit" class="search-button" aria-label="Submit Search">

      <i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>

    </button>

    <button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">

      <i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>

    </button>

    <label class="search-label">

      <p class="sr-only">Search</p>

      <input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />

    </label>

  </form>



  <div class="autocomplete">

    <div class="autocomplete-results">

    </div>

  </div>



  <div class="sidebar-header">



    <div class="sidebar-projectDetails">

      <a href="api-reference.html" class="sidebar-projectName" translate="no">

ldap

      </a>

      <div class="sidebar-projectVersion" translate="no">

        v13.7.26

      </div>

    </div>

    <ul class="sidebar-listNav">

      <li><a id="extras-list-link" href="#full-list">Pages</a></li>



        <li><a id="modules-list-link" href="#full-list">Modules</a></li>





    </ul>

  </div>



  <div class="gradient"></div>

  <ul id="full-list"></ul>

</section>



<section class="content">

  <output role="status" id="toast"></output>

  <div class="content-outer">

    <div id="content" class="content-inner">



<h1>

<button class="icon-action display-settings">

  <i class="ri-settings-3-line"></i>

  <span class="sr-only">Settings</span>

</button>





  <span translate="no">LDAP</span> 

  <small class="app-vsn" translate="no">(ldap v13.7.26)</small>



</h1>





  <section id="moduledoc">

<p>The LDAPv3 server implementation module.</p>

  </section>





  <section id="summary" class="details-list">

    <h1 class="section-heading">

      <a class="hover-link" href="#summary">

        <i class="ri-link-m" aria-hidden="true"></i>

        Summary

      </a>

    </h1>

<div class="summary-functions summary">

  <h2>

    <a href="#functions">Functions</a>

  </h2>



    <div class="summary-row">

      <div class="summary-signature">

        <a href="#attr/2" translate="no">attr(k, v)</a>



      </div>



        <div class="summary-synopsis"><p>The <code class="inline">PartialAttribute</code> ASN.1 constructor.</p></div>



    </div>



    <div class="summary-row">

      <div class="summary-signature">

        <a href="#child_spec/1" translate="no">child_spec(init_arg)</a>



      </div>



        <div class="summary-synopsis"><p>Returns a specification to start this module under a supervisor.</p></div>



    </div>



    <div class="summary-row">

      <div class="summary-signature">

        <a href="#init/1" translate="no">init(list)</a>



      </div>



        <div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/elixir/Supervisor.html#c:init/1"><code class="inline">Supervisor.init/1</code></a>.</p></div>



    </div>



    <div class="summary-row">

      <div class="summary-signature">

        <a href="#list/1" translate="no">list(name)</a>



      </div>



        <div class="summary-synopsis"><p>Dump database.</p></div>



    </div>



    <div class="summary-row">

      <div class="summary-signature">

        <a href="#message/4" translate="no">message(no, socket, msg, db)</a>



      </div>



        <div class="summary-synopsis"><p>The public LDAPv3 protocol handler function.</p></div>



    </div>



    <div class="summary-row">

      <div class="summary-signature">

        <a href="#node/2" translate="no">node(dn, attrs)</a>



      </div>



        <div class="summary-synopsis"><p>The <code class="inline">SearchResultEntry</code> ASN.1 constructor.</p></div>



    </div>



    <div class="summary-row">

      <div class="summary-signature">

        <a href="#start/0" translate="no">start()</a>



      </div>



        <div class="summary-synopsis"><p>Start server base on <code class="inline">:port</code> and <code class="inline">:instance</code> application environment parameters.</p></div>



    </div>



    <div class="summary-row">

      <div class="summary-signature">

        <a href="#start/2" translate="no">start(type, args)</a>



      </div>



        <div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/elixir/Application.html#c:start/2"><code class="inline">Application.start/2</code></a>.</p></div>



    </div>



</div>



  </section>





  <section id="functions" class="details-list">

    <h1 class="section-heading">

      <a class="hover-link" href="#functions">

        <i class="ri-link-m" aria-hidden="true"></i>

Functions

      </a>

    </h1>

    <div class="functions-list">

<section class="detail" id="attr/2">



  <div class="detail-header">

    <a href="#attr/2" class="detail-link" title="Link to this function">

      <i class="ri-link-m" aria-hidden="true"></i>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature" translate="no">attr(k, v)</h1>





  </div>



  <section class="docstring">



<p>The <code class="inline">PartialAttribute</code> ASN.1 constructor.</p>

  </section>

</section>

<section class="detail" id="child_spec/1">



  <div class="detail-header">

    <a href="#child_spec/1" class="detail-link" title="Link to this function">

      <i class="ri-link-m" aria-hidden="true"></i>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature" translate="no">child_spec(init_arg)</h1>





  </div>



  <section class="docstring">



<p>Returns a specification to start this module under a supervisor.</p><p>See <a href="https://hexdocs.pm/elixir/Supervisor.html"><code class="inline">Supervisor</code></a>.</p>

  </section>

</section>

<section class="detail" id="init/1">



  <div class="detail-header">

    <a href="#init/1" class="detail-link" title="Link to this function">

      <i class="ri-link-m" aria-hidden="true"></i>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature" translate="no">init(list)</h1>





  </div>



  <section class="docstring">



<p>Callback implementation for <a href="https://hexdocs.pm/elixir/Supervisor.html#c:init/1"><code class="inline">Supervisor.init/1</code></a>.</p>

  </section>

</section>

<section class="detail" id="list/1">



  <div class="detail-header">

    <a href="#list/1" class="detail-link" title="Link to this function">

      <i class="ri-link-m" aria-hidden="true"></i>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature" translate="no">list(name)</h1>





  </div>



  <section class="docstring">



<p>Dump database.</p>

  </section>

</section>

<section class="detail" id="message/4">



  <div class="detail-header">

    <a href="#message/4" class="detail-link" title="Link to this function">

      <i class="ri-link-m" aria-hidden="true"></i>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature" translate="no">message(no, socket, msg, db)</h1>





  </div>



  <section class="docstring">



<p>The public LDAPv3 protocol handler function.</p>

  </section>

</section>

<section class="detail" id="node/2">



  <div class="detail-header">

    <a href="#node/2" class="detail-link" title="Link to this function">

      <i class="ri-link-m" aria-hidden="true"></i>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature" translate="no">node(dn, attrs)</h1>





  </div>



  <section class="docstring">



<p>The <code class="inline">SearchResultEntry</code> ASN.1 constructor.</p>

  </section>

</section>

<section class="detail" id="start/0">



  <div class="detail-header">

    <a href="#start/0" class="detail-link" title="Link to this function">

      <i class="ri-link-m" aria-hidden="true"></i>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature" translate="no">start()</h1>





  </div>



  <section class="docstring">



<p>Start server base on <code class="inline">:port</code> and <code class="inline">:instance</code> application environment parameters.</p>

  </section>

</section>

<section class="detail" id="start/2">



  <div class="detail-header">

    <a href="#start/2" class="detail-link" title="Link to this function">

      <i class="ri-link-m" aria-hidden="true"></i>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature" translate="no">start(type, args)</h1>





  </div>



  <section class="docstring">



<p>Callback implementation for <a href="https://hexdocs.pm/elixir/Application.html#c:start/2"><code class="inline">Application.start/2</code></a>.</p>

  </section>

</section>



    </div>

  </section>



      <footer class="footer">

        <p>



            <span class="line">

              <a href="https://hex.pm/packages/ldap/13.7.26" class="footer-hex-package">Hex Package</a>



              <a href="https://preview.hex.pm/preview/ldap/13.7.26">Hex Preview</a>



                (<a href="https://preview.hex.pm/preview/ldap/13.7.26/show/lib/ldap.ex">current file</a>)



            </span>



          <span class="line">

            <button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">

              Search HexDocs

            </button>



              <a href="ldap.epub" title="ePub version">

                Download ePub version

              </a>



          </span>

        </p>



        <p class="built-using">

          Built using

          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.30.3) for the



            <a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>



        </p>

      </footer>

    </div>

  </div>

</section>

</div>





  </body>

</html>