Packages

ldap

14.6.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.38.2">

    <meta name="project" content="ldap v14.6.26">





    <title>LDAP — ldap v14.6.26</title>



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



    <script defer src="dist/sidebar_items-26B45101.js"></script>

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

    <script defer src="dist/html-DPJLHKSM.js"></script>



  </head>

  <body>

    <script>(()=>{var t="ex_doc:settings",e="dark";var o="dark",s="light";var E="sidebar_state",n="closed";var r="sidebar_width";var a="sidebar-open";var i=new URLSearchParams(window.location.search),S=i.get("theme")||JSON.parse(localStorage.getItem(t)||"{}").theme;(S===o||S!==s&&window.matchMedia("(prefers-color-scheme: dark)").matches)&&document.body.classList.add(e);var d=sessionStorage.getItem(E),A=d!==n&&!window.matchMedia(`screen and (max-width: ${768}px)`).matches;document.body.classList.toggle(a,A);var c=sessionStorage.getItem(r);c&&document.body.style.setProperty("--sidebarWidth",`${c}px`);var p=/(Macintosh|iPhone|iPad|iPod)/.test(window.navigator.userAgent);document.documentElement.classList.toggle("apple-os",p);})();

</script>



<div class="body-wrapper">



<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">

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

</button>



<nav id="sidebar" class="sidebar">



  <div class="sidebar-header">

    <div class="sidebar-projectInfo">



      <div>

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

ldap

        </a>

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

          v14.6.26

        </div>

      </div>

    </div>

    <ul id="sidebar-list-nav" class="sidebar-list-nav" role="tablist" data-extras=""></ul>

  </div>

</nav>



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



<main class="content page-module" id="main" data-type="modules">

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

    <div class="top-search">

      <div class="search-settings">

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

          <label class="search-label">

            <span class="sr-only">Search documentation of ldap</span>

            <input name="q" type="text" class="search-input" placeholder="Press / to search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />

          </label>

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

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

          </button>

          <button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">

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

          </button>

        </form>

        <div class="autocomplete">

        </div>

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

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

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

        </button>

      </div>

    </div>



<div id="top-content">

  <div class="heading-with-actions top-heading">

    <h1>

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

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



    </h1>



  </div>





    <section id="moduledoc">

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

    </section>



</div>



  <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>

      </a>

      <span class="text">Summary</span>

    </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" data-no-tooltip="" 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" data-no-tooltip="" 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" data-no-tooltip="" translate="no">init(list)</a>



      </div>



        <div class="summary-synopsis"><p>Callback implementation for <a><code class="inline">Supervisor.init/1</code></a>.</p></div>



    </div>



    <div class="summary-row">

      <div class="summary-signature">

        <a href="#list/1" data-no-tooltip="" 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" data-no-tooltip="" 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" data-no-tooltip="" 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" data-no-tooltip="" 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" data-no-tooltip="" translate="no">start(type, args)</a>



      </div>



        <div class="summary-synopsis"><p>Callback implementation for <a><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>

      </a>

      <span class="text">Functions</span>

    </h1>

    <div class="functions-list">

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



  <div class="detail-header">

    <a href="#attr/2" class="detail-link" data-no-tooltip="" aria-label="Link to this function">

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

    </a>

    <div class="heading-with-actions">

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





    </div>

  </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" data-no-tooltip="" aria-label="Link to this function">

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

    </a>

    <div class="heading-with-actions">

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





    </div>

  </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" data-no-tooltip="" aria-label="Link to this function">

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

    </a>

    <div class="heading-with-actions">

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





    </div>

  </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" data-no-tooltip="" aria-label="Link to this function">

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

    </a>

    <div class="heading-with-actions">

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





    </div>

  </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" data-no-tooltip="" aria-label="Link to this function">

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

    </a>

    <div class="heading-with-actions">

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





    </div>

  </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" data-no-tooltip="" aria-label="Link to this function">

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

    </a>

    <div class="heading-with-actions">

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





    </div>

  </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" data-no-tooltip="" aria-label="Link to this function">

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

    </a>

    <div class="heading-with-actions">

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





    </div>

  </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" data-no-tooltip="" aria-label="Link to this function">

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

    </a>

    <div class="heading-with-actions">

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





    </div>

  </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/14.6.26" class="footer-hex-package">Hex Package</a>



            <a href="https://preview.hex.pm/preview/ldap/14.6.26">Hex Preview</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.38.2) for the



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



      </p>



    </footer>

  </div>

</main>

</div>



  </body>

</html>