Files
Max Lv d6691b9e33 C++20 port 4/14: compile the event loop, UDP relay and programs as C++ (#3068)
* Make the event loop, UDP relay and programs compile as C++

Cast allocator results and void* callback data explicitly, cast string
literals stored in char * variables, replace compound literals in
ss_event.c with zeroing plus member assignment, and give ss-server's
listener array its MAX_REMOTE_NUM bound instead of a VLA.

Where a goto CLEAN_UP jumps over an initialised declaration (C++
rejects that), split the declaration from its initialisation in place.
The variables were already indeterminate at the label in C, and the
cleanup code does not read them. Checked for every MODULE_* variant of
udprelay.c, plus LIB_ONLY for local.c. Still valid C.

* Compile the event loop, UDP relay and programs as C++

Rename utils, ss_event, udprelay, winsock, local, server, tunnel, redir
and manager from .c to .cpp. Inside the moved files only the
\snippet{doc} file references and header comments change; snippet
references in doc/*.md, tests/test_cli_docs.py, the build files and
CONTRIBUTION.md follow the new names.

Also cast the Windows-only string literal returned by
get_default_conf(), found by the zig x86_64-windows-gnu build.

Every module of src/ except the unbuilt android.c and the vendored
blake3 is now compiled as C++20. The new .cpp files join the no-heap
ratchet baseline.

* Add the two casts ss-redir needs as C++

ss-redir only builds on Linux, so the macOS conversion checks never
compiled it: getsockname() wants a struct sockaddr *, and memcpy's
void * result needs a cast.
2026-10-15 09:53:31 +08:00

1.7 KiB

\page ss-server ss-server

\brief shadowsocks server, C implementation

\section ss_server_synopsis SYNOPSIS

ss-server [options]

\section ss_server_description DESCRIPTION

shadowsocks-c is a lightweight and secure socks5 proxy. It is a port of the original shadowsocks created by clowwindy. shadowsocks-c is written in pure C and takes advantage of libuv to achieve both high performance and low resource consumption.

shadowsocks-c consists of five components. ss-server(1) runs on a remote server to provide secured tunnel service. For more information, check out shadowsocks-libev(8).

\section ss_server_options OPTIONS

Options include all supported platform variants; restrictions are noted below.

\snippet{doc} server.cpp cli-options

\section ss_server_example EXAMPLE

It is recommended to use a config file when starting ss-server(1).

The config file is written in JSON and is easy to edit. Check out the SEE ALSO section for the default path of config file.

# Start the ss-server
ss-server --config /etc/shadowsocks-libev/config.json

\section ss_server_incompatibility INCOMPATIBILITY

The config file of shadowsocks-libev(8) is slightly different from original shadowsocks.

In order to listen to both IPv4/IPv6 address, use the following grammar in your config json file:

{
"server":["::0","0.0.0.0"],
...
}

ss-server(1) also does not understand "port_password" field in config file. If you want to start up multiple server instances with a single config file, please try ss-manager tool. See ss-manager(8) for details.

\section ss_server_see_also SEE ALSO

ss-local(1), ss-tunnel(1), ss-redir(1), ss-manager(1), shadowsocks-libev(8), iptables(8), /etc/shadowsocks-libev/config.json