websocket-lwt-unix 2.16 · OCaml Package

websocket-lwt-unix

To focus the search input from anywhere on the page, press the 'S' key.

in-package search v0.1.0

Websocket library (Lwt)

Install

github.com Readme ISC License Edit opam file

Authors

V

Vincent Bernardoff <vb@luminar.eu.org>

Maintainers

V

Vincent Bernardoff <vb@luminar.eu.org>

Sources

websocket-2.16.tbz

sha256=1221f4683ddad884dbd62bc3f0ee59e8cd1b0c770c356357c5e6100ac87dc5eb

sha512=1561b022380e6bc21561d36cbce1e2e28cdd08fc47f5c91f7dd9f514cb1b3f4866534512f22e85086727a758695c22125735397b5955a70f476e1b9d8cbc75c4

README.md.html

ocaml-websocket — Websocket library for OCaml

The WebSocket Protocol enables two-way communication between a client
running untrusted code in a controlled environment to a remote host
that has opted-in to communications from that code.

The security model used for this is the origin-based security model
commonly used by web browsers. The protocol consists of an opening
handshake followed by basic message framing, layered over TCP.

The goal of this technology is to provide a mechanism for
browser-based applications that need two-way communication with
servers that does not rely on opening multiple HTTP connections (e.g.,
using XMLHttpRequest or s and long polling).</p><h3>Installation</h3><p>ocaml-websocket can be installed with <code>opam</code>:</p><pre class="language-markdown"><code>opam install websocket </code></pre><p>If you don't use <code>opam</code> please consult the <code>websocket.opam</code>,<br/><code>websocket-lwt.opam</code> and <code>websocket-async.opam</code> files for build<br/>instructions.</p> </div> </div> </div> </div> </div> </div> <div class="hidden xl:flex top-0 sticky h-screen flex-col w-60 overflow-auto md:pb-24"> <div class="pt-6"> <div x-data='toc' @scroll.window="scrollY = window.scrollY" @resize.window="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)" x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)" > </div> </div> </div> </div> </div> </div> </div> <script> document.addEventListener('alpine:init', () => { function computeSectionYPositions(toc_el) { function get_y(href) { let heading = document.getElementById(href.substring(1)); return heading.getBoundingClientRect().top + window.scrollY - 60; } let sections = {}; let els = toc_el.querySelectorAll("a"); let l = els.length; for (let i=0; i<l; i++) { let target_href = els[i].getAttribute("href"); let next_el_href = i < l-1 ? els[i+1].getAttribute("href") : null; sections[target_href] = { start: get_y(target_href), end: next_el_href ? get_y(next_el_href) : null, } } return sections; } function isWithin(scrollY, href, sectionYPositions) { if (sectionYPositions == null) return false; return scrollY > sectionYPositions[href].start && (scrollY <= sectionYPositions[href].end || sectionYPositions[href].end == null) } Alpine.data('toc', () => ( { scrollY: window.scrollY, sectionYPositions: null, isWithin, computeSectionYPositions, } )) }) </script> <script src="/_/YTU5NjQ0ZTJjYjk1NTcwOWZmNDA3ZjAwOWI5ZDI2M2Q/vendors/minisearch.min.js"></script> <script> function Fuse() {} </script> <script> { let miniSearch; let results = []; function goToUrl(event, location) { event.preventDefault(); event.stopPropagation(); if (location.indexOf("#") != -1) { let [url, hash] = location.split("#"); if (window.location.pathname.startsWith(url)) { window.location.hash = hash; setTimeout(() => { var el = document.getElementById(hash); var targetPosition = el.getBoundingClientRect().top + window.scrollY - 70; window.scrollTo({ top: targetPosition, behavior: "instant" }) }, 10); return; } } window.location = location; } function shortness_factor(r) { return 1 + 2*Math.log(1 + 1/(r.prefixname.length + r.name.length)); } function perform_search() { let q = document.getElementById("in-package-search-input").value; results = miniSearch.search(q, { fields: ['name', 'prefixname', 'comment'], prefix: true, boost: { name: 6, prefixname: 2.5, comment: 0.8, }, fuzzy: 0.15, }).slice(0,50); results = results.map(r => {return {...r, score: r.score * shortness_factor(r), shortness: shortness_factor(r)}}).sort((r1,r2) => r2.score - r1.score); let container = document.getElementById("in-package-search-results"); container.innerHTML = ``; let search_results = document.createElement("ol"); results.map((entry) => { let kind = document.createElement("tt"); kind.innerText = entry.kind .replace("module type", "mty").replace("root", "mod").replace("module", "mod") .replace("method", "mtd").replace("class type", "cty").replace("class", "cls") .replace("core type", "typ").replace("type", "typ") .replace("exception", "exc").replace("core exception", "exc") .replace("parameter", "par") .replace("leaf page", "man").replace("page", "man"); kind.title = entry.kind; kind.classList.add("entry-kind"); let list_item = document.createElement("li"); let a = document.createElement("a"); let href = "/" + entry.url; a.href = href; a.id = "search-result-"+entry.id; a.classList.add("search-entry", kind.innerText.slice(0,3)); let title = document.createElement("div"); title.classList.add("entry-title"); let prefixname = document.createElement("tt"); prefixname.innerText = entry.prefixname + (entry.prefixname != "" ? ".": ""); prefixname.classList.add("prefix-name"); let name = document.createElement("tt"); name.classList.add("entry-name"); name.innerText = entry.name; title.appendChild(kind); title.appendChild(prefixname); title.appendChild(name); let comment = document.createElement("div"); comment.innerText = entry.comment; comment.classList.add("entry-comment"); a.appendChild(title); a.appendChild(comment); a.addEventListener("click", (event) => goToUrl(event, href)); list_item.appendChild(a); search_results.appendChild(list_item); }); container.appendChild(search_results); search_results_position = null; } function init_search() { documents = documents.map((d, i) => {return {...d, id: i}}); miniSearch = new MiniSearch({ fields: ['name', 'prefixname', 'comment'], storeFields: ['name', 'prefixname', 'kind', 'url', 'comment'], }); miniSearch.addAll(documents); document.getElementById("in-package-search-input").addEventListener("input", perform_search); perform_search(); } function user_interacts() { let scriptTag = document.createElement("script"); scriptTag.src = "/p/websocket-lwt-unix/2.16/search-index/hvqKeWJGDkIeOqtvkJpwLQ"; scriptTag.addEventListener("load", init_search); document.body.appendChild(scriptTag); let container = document.getElementById("in-package-search-results"); container.innerHTML = `<div class="px-4 py-2">Loading...</div>`; document.getElementById("in-package-search-input").removeEventListener("focus", user_interacts); } document.getElementById("in-package-search-input").addEventListener("focus", user_interacts); let search_results_position = null; function adjust_position(event) { if (results.length == 0) return; if (event.key == "ArrowDown") { if (search_results_position === null) { search_results_position = 0; return; } if (search_results_position < results.length - 1) { search_results_position++; return; } } else if (event.key == "ArrowUp") { if (search_results_position === null) return; if (search_results_position == 0) { search_results_position = null; return; } search_results_position--; return; } } function keydown(event) { event.stopPropagation(); if (event.key == "Enter") { if (results.length > 0) { let url = "/"+results[search_results_position || 0].url; goToUrl(event, url) } return false; } if (search_results_position !== null) document.getElementById("search-result-"+results[search_results_position].id).classList.remove("active"); adjust_position(event); document.getElementById("in-package-search-input").setAttribute("aria-activedescendant", search_results_position === null ? null : "search-result-"+results[search_results_position].id); if (search_results_position !== null) { let el = document.getElementById("search-result-"+results[search_results_position].id); el.classList.add("active"); el.scrollIntoView({block: "end"}); } } document.getElementById("in-package-search-input").addEventListener("keydown", keydown); document.addEventListener("keydown", (event) => { if (event.key == "s") { document.getElementById("in-package-search-input").focus(); document.getElementById("in-package-search-input").select(); event.preventDefault(); event.stopPropagation(); } }) } </script> </main> <footer class="bg-background-default border-t border-gray-200 pt-12 pb-20 md:p-0 md:fixed md:bottom-0 md:h-12 md:z-50 w-full" aria-labelledby="footer-heading"> <h2 id="footer-heading" class="sr-only">Footer</h2> <div class="container-fluid wide"> <ul class="flex flex-col md:flex-row md:flex-wrap md:h-12 gap-x-6"> <li> <a class="h-10 md:h-12 flex items-center mb-6 md:mb-0" href="/"><img class="h-8 md:h-6 pb-1" src="/_/YTY2ODhjNjU2NzljODk5ODY4ODJmNTAyMDhmOTJhNDM/logo-with-name.svg" alt="OCaml"></a> </li> <li> <a class="h-10 md:h-12 flex items-center text-gray-600" href="/docs/up-and-running" class="text-base leading-6 text-gray-600">Get Started</a> </li> <li> <a class="h-10 md:h-12 flex items-center text-gray-600" href="/releases/latest/api/index.html" class="text-base leading-6 text-gray-600">Standard Library API</a> </li> <li> <a class="h-10 md:h-12 flex items-center text-gray-600" href="/releases" class="text-base leading-6 text-gray-600">Releases</a> </li> <li> <a class="h-10 md:h-12 flex items-center text-gray-600" href="/jobs" class="text-base leading-6 text-gray-600">Jobs</a> </li> <li> <a class="h-10 md:h-12 flex items-center text-gray-600" href="/policies/privacy-policy">Privacy</a> </li> </ul> </div> </footer> </body> </html>