mirror of
https://github.com/fluffos/fluffos
synced 2026-08-12 18:26:06 -04:00
c914f03d66
* 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>
83 lines
2.3 KiB
Markdown
83 lines
2.3 KiB
Markdown
---
|
|
title: sockets / socket_create
|
|
---
|
|
# socket_create
|
|
|
|
### NAME
|
|
|
|
socket_create() - create an efun socket
|
|
|
|
### SYNOPSIS
|
|
|
|
#include <socket_err.h>
|
|
|
|
int socket_create( int mode, string read_callback,
|
|
void | string close_callback );
|
|
|
|
### DESCRIPTION
|
|
|
|
socket_create() creates an efun socket. mode determines which type of
|
|
socket is created. Currently supported socket modes are:
|
|
|
|
0 MUD for sending LPC data types using TCP protocol.
|
|
|
|
1 STREAM for sending raw data using TCP protocol.
|
|
|
|
2 DATAGRAM for using UDP protocol.
|
|
|
|
3 STREAM_BINARY for exchange binary message with TCP protocol.
|
|
|
|
4 DATAGRAM_BINARY for exchange binary message with UDP protocol.
|
|
|
|
5 STREAM_TLS for sending raw data using TLS/SSL over TCP protocol.
|
|
|
|
6 STREAM_TLS_BINARY for exchange binary message with TLS/SSL over TCP protocol.
|
|
|
|
The argument read_callback is the name of a function for the driver to
|
|
call when the socket gets data from its peer. The read callback should
|
|
follow this format:
|
|
|
|
void read_callback(int fd, mixed message, string addr)
|
|
|
|
Where fd is the socket which received the data, and message is the data
|
|
which was received, addr is the client address.
|
|
|
|
In non-binary mode, message will be sanitized with UTF8 encoding and returned as an string.
|
|
|
|
In binary mode, raw messages will be returned as a buffer.
|
|
|
|
The argument close_callback is the name of a function for the driver to
|
|
call if the socket closes unexpectedly, i.e. not as the result of a
|
|
socket_close(3) call. The close callback should follow this format:
|
|
|
|
void close_callback(int fd)
|
|
|
|
Where fd is the socket which has closed. NOTE: close_callback is not
|
|
used with DATAGRAM mode sockets.
|
|
|
|
### RETURN VALUES
|
|
|
|
socket_create() returns:
|
|
|
|
a non-negative descriptor on success.
|
|
|
|
a negative value indicated below on error.
|
|
|
|
### ERRORS
|
|
|
|
EEMODENOTSUPP Socket mode not supported.
|
|
|
|
EESOCKET Problem creating socket.
|
|
|
|
EESETSOCKOPT Problem with setsockopt.
|
|
|
|
EENONBLOCK Problem setting non-blocking mode.
|
|
|
|
EENOSOCKS No more available efun sockets.
|
|
|
|
EESECURITY Security violation attempted.
|
|
|
|
### SEE ALSO
|
|
|
|
socket_accept(3), socket_bind(3), socket_close(3), socket_connect(3),
|
|
socket_listen(3), socket_write(3)
|