fluffos/docs/efun/sockets/socket_acquire.md
Yucong Sun c914f03d66
Add local search and documentation guide for docs site (#1221)
* docs: add local full-text search and a contributor README

Add @easyops-cn/docusaurus-search-local to the Docusaurus site so the
docs get an offline search bar (index built at build time, no external
service). English and zh-CN pages are both indexed, and matched terms
are highlighted on the target page.

Add docs/README.md describing the Docusaurus setup, local dev/build
commands, search behavior, directory layout, and gotchas; exclude it
from the published site alongside CLAUDE.md. Point the root README's
docs/ entry at it.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

* docs: remove dead framework leftovers, fix index generation, complete the nav

Delete the VitePress (.vitepress/) and Jekyll (_layouts/, css/) leftovers,
the one-shot migration scripts (fix_md_header.py, fix_seealso.py), and the
stale keywords.json snapshot; prune the matching .gitignore entries and
docusaurus exclude patterns.

Rewrite gen_index.py for Docusaurus: it emitted dead .html links and
legacy 'layout: doc' frontmatter, choked on non-markdown entries, and
dropped nested categories — regenerating an index would have broken it.
It now emits the extension-less links the site actually uses, links
nested category indexes (restoring apply/* on the zh-CN index), and
refuses to run on the docs root. Fix update_index.sh's copy-paste titles
(zh-CN efun/build were titled 'APPLY'), stop it clobbering the
hand-written lpc/index.md, and cover cli/. Regenerated indexes pick up
the missing driver/ffi-plan entry. add_missing_efuns.py now takes the
keywords.json path as an argument instead of requiring a stale copy.

Move CNAME and the Google site-verification file into static/ so they
actually reach the published build output.

Complete the sidebar: link the CLI category to cli/index and add the
missing portbind/symbol/generate_keywords pages, and expose the
previously orphaned stdlib section under Reference.

Promote onBrokenLinks to 'throw' now the build is warning-free, and drop
the empty Demo section from the landing page.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

* docs: strip legacy 'layout: doc' frontmatter from all pages

Mechanical sweep removing the Jekyll-era 'layout: doc' line from every
doc page's frontmatter (Docusaurus ignores it), and the matching line
from the templates in docs/CLAUDE.md so new pages don't reintroduce it.
No content changes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

---------

Co-authored-by: Claude <noreply@anthropic.com>
2026-07-09 22:09:55 -04:00

1.6 KiB
Raw Permalink Blame History

title
sockets / socket_acquire

socket_acquire

NAME

socket_acquire() - assume ownership of a socket

SYNOPSIS

#include <socket_err.h>

int socket_acquire( int socket, string read_callback,
                    string write_callback,
                    string close_callback );

DESCRIPTION

socket_acquire()   is   called  to  complete  the  handshake  begun  by
socket_release() for transferring ownership (and control) of  a  socket
to  a new object.  socket_release() calls the release callback function
within the new owner object to notify the object that it wishes to pass
control  of  the  socket on.  It is the responsibility of the new owner
socket to decide whether it wishes to accept the socket.  It  it  does,
then socket_acquire() is called to complete the transfer.  If not, then
the callback simply returns without completing the handshake.

In the former case the  handshake  is  completed  and  the  new  object
becomes  the socket owner.  The read, write and close callback function
parameters refer to functions within the new object.  These are  speci
fied  so that the MudOS driver will know which functions to call within
the  new  object.   Decling  to   acquire   the   socket   will   cause
socket_release()  to  return  EESOCKNOTRLSD  so  the  owner can perform
appropriate clean-up.

socket_acquire() may only be called within the context of  thr  release
callback function and only with the socket specified.

SEE ALSO

socket_release(3)