Swow

https://docs.toast.run/swow/en
Admin
Swow is a high-performance, asynchronous, coroutine-based PHP framework designed for building robust...
Tokens:22,357
Snippets:149
Trust Score:4.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Manual Build and Install Swow Extension (UNIX-like)

Source: https://docs.toast.run/swow/en/install

Provides steps for manually building and installing the Swow extension from source on UNIX-like systems. This includes fetching the source code, running `phpize`, configuring the build, compiling with `make`, and installing with `make install`.

```bash
# fetch source
git clone https://github.com/swow/swow.git swow
cd swow/ext
# generate configure
phpize
# execute configure, for build args, see below
./configure
# make it, use -jx to make concurrency
make -j4
# install it, if your prefix is not in system path, "sudo" can be omitted
sudo make install
```

--------------------------------

### Install and Debug Swow Extension

Source: https://docs.toast.run/swow/en/install

Compiles and installs the Swow extension, enabling debug mode. The process may prompt for administrator privileges for system path installation. It also shows how to verify the installation by running the extension directly.

```bash
php vendor/bin/swow-builder --install --debug
```

```bash
/usr/bin/env php -d extension=/path/to/your-project/vendor/swow/swow/ext/modules/swow.so --ri swow
```

```bash
php -d extension=swow
```

--------------------------------

### HTTP + WebSocket Mixed Server Example

Source: https://docs.toast.run/swow/en/index

An example of a mixed HTTP and WebSocket server written in Swow with less than 100 lines of code. It achieves a 100K-level QPS and is written in a purely synchronous style, free from asynchronous callbacks.

```PHP
<?php

require __DIR__ . '/../vendor/autoload.php';

use Swow\Coroutine;
use Swow\Http\Server as HttpServer;
use Swow\WebSocket\Server as WebSocketServer;

// Create an HTTP server
$httpServer = new HttpServer('0.0.0.0', 8080);

// Handle HTTP requests
$httpServer->on("request", function (HttpServer $server, int $fd) {
    $server->header("Content-Type", "text/plain");
    $server->end("Hello from Swow HTTP server!");
});

// Create a WebSocket server
$webSocketServer = new WebSocketServer('0.0.0.0', 8081);

// Handle WebSocket connections
$webSocketServer->on("message", function (WebSocketServer $server, int $fd, string $message) {
    // Broadcast message to all connected clients
    $server->broadcast($message);
});

// Start both servers
$httpServer->start();
$webSocketServer->start();

// Keep the servers running
Coroutine::yield();

```

--------------------------------

### Swow Builder Script Usage

Source: https://docs.toast.run/swow/en/install

This section provides a comprehensive list of commands and options for the `swow-builder` script, used for compiling and installing Swow extensions. It covers basic compilation, specifying PHP configurations, dry runs, log viewing, quiet operation, cleaning, rebuilding, and installation with or without sudo privileges, as well as enabling specific features like SSL and cURL.

```bash
# Compiles extension
php vendor/bin/swow-builder

# Compiles extension and specify the php-config path
php vendor/bin/swow-builder --php-config=/path/to/php-config

# Show help
php vendor/bin/swow-builder --help

# Simulate running, used to view the compilation command
php vendor/bin/swow-builder --dry-run

# Show full compilation log
php vendor/bin/swow-builder --show-log

# Do not ask during the compilation process (such as whether to install)
php vendor/bin/swow-builder --quiet

# Clean and compile extension
php vendor/bin/swow-builder --clean

# Re-configure and clean and compile extension
php vendor/bin/swow-builder --rebuild

# Compile and install extension
php vendor/bin/swow-builder --install

# Compile and install extension with administrator privileges
php vendor/bin/swow-builder --install --sudo

# Clean and compile and install extension
php vendor/bin/swow-builder --clean --install

# Re-configure and clean and compile and install extension
php vendor/bin/swow-builder --rebuild --install

# Re-configure and compile and install extension and manually specify that some features are enabled
php vendor/bin/swow-builder --rebuild --install --ssl --curl

```

--------------------------------

### Prepare Development Prerequisites on Linux

Source: https://docs.toast.run/swow/en/install

Installs necessary development libraries for cURL and SSL support on various Linux distributions. This is a prerequisite for building Swow with cURL or SSL capabilities.

```shell
# debian and its variant like ubuntu, kali, armbian, raspbian, deepin, uos
apt-get install libcurl4-openssl-dev libssl-dev
# fedora, rhel 8, centos 8
dnf install libcurl-devel openssl-devel
# legacy fedora, rhel 6/7, centos 6/7
yum install libcurl-devel openssl-devel
# archlinux and its variant like manjaro, archlinuxarm, blackarch
pacman -S curl openssl
# alpine
# if it warns "openssl1.1-compat-dev-1.1.1xxx: conflicts", install curl-dev only
apk add curl-dev openssl-dev
# opensuse, suse
zypper install libcurl-devel libopenssl-devel
```

--------------------------------

### TCP Echo Server Example

Source: https://docs.toast.run/swow/en/index

A high-performance TCP echo server with heartbeat functionality implemented in Swow. This example demonstrates Swow's capabilities in network programming with a concise 24 lines of code.

```PHP
<?php

require __DIR__ . '/../vendor/autoload.php';

use Swow\Coroutine;
use Swow\Socket\StreamServer;

// Create a TCP server
$server = new StreamServer('0.0.0.0', 9000);

// Handle incoming connections
$server->on("receive", function (StreamServer $server, int $fd, string $buffer) {
    // Echo back the received data
    $server->send($fd, $buffer);
});

// Start the server
$server->start();

// Keep the server running
Coroutine::yield();

```

--------------------------------

### Install Swow via Composer

Source: https://docs.toast.run/swow/en/install

This snippet shows how to add the Swow extension to your project using Composer, a dependency manager for PHP.

```bash
composer require swow/swow

```

--------------------------------

### Prepare Development Prerequisites on macOS

Source: https://docs.toast.run/swow/en/install

Installs cURL and OpenSSL using Homebrew on macOS. It also advises on setting the `PKG_CONFIG_PATH` environment variable, which is crucial for the build process.

```bash
brew install curl openssl
```

--------------------------------

### Build Swow Extension

Source: https://docs.toast.run/swow/en/install

Commands to build the Swow extension after preparing the environment. This includes cloning the Swow repository, running phpize, configuring the build, and executing nmake.

```batch
git clone https://github.com/swow/swow.git swow
CD swow\ext
C:\php-8.0.1-devel-vs16-x64\phpize.bat
configure.bat --enable-swow --with-php-build=C:\deps
nmake
```

--------------------------------

### Micro Wiki - Adding Extensions

Source: https://docs.toast.run/swow/en/index

Instructions on how to add a PHP extension to the micro framework.

```en
How to add an extension into micro.sfx
```

--------------------------------

### Micro Wiki - SAPI Interface

Source: https://docs.toast.run/swow/en/index

Documentation regarding the SAPI (Server Application Programming Interface) interface within the micro framework.

```en
SAPI Interface
```

--------------------------------

### Micro Wiki - INI Configuration

Source: https://docs.toast.run/swow/en/index

Details on how to configure the micro framework using INI files.

```en
INI Configuration
```

--------------------------------

### Clone php-sdk-binary-tools

Source: https://docs.toast.run/swow/en/install

Clones the official PHP SDK binary tools repository from GitHub. This is a prerequisite for building PHP extensions on Windows.

```bash
git clone https://github.com/php/php-sdk-binary-tools
```

--------------------------------

### SDB Usage with -e Option

Source: https://docs.toast.run/swow/en/faq

This snippet explains the requirement to use the '-e' option with SDB for debugging. It provides an example of the error message and the correct command-line usage, noting that enabling '-e' might impact performance.

```text
> attach 3
Error: Please re-run your program with "-e" option in path/to/vendor/swow/swow/lib/swow-library/src/Debug/Debugger/Debugger.php:0

Append `-e` argument in php command line like: `php -e your_file.php`.
When `-e` is enabled, PHP will call extension registered OPCode hanlder, this may harm performance in usual.
```

--------------------------------

### Swow PDO PostgreSQL Hook Configuration

Source: https://docs.toast.run/swow/en/faq

This documentation entry explains a warning related to the Swow PDO PostgreSQL hook not being enabled. It details the conditions under which this warning appears (e.g., Swow compiled with pgsql support but no pgsql environment) and provides solutions, including enabling the PDO extension, installing libpq, or disabling the hook via `swow.hook_pdo_pgsql = Off;`.

```text
“PHP Warning: PHP Startup: Swow pdo_pgsql hook not enabled” after Swow enabled 
If you have Swow compiled with pgsql support, but no pgsql environment when starting:
  * PDO extension is enabled: “pdo extension not enabled”
  * No libpq found: “libpq.so/libpq.5.dylib/lipq.dll not found” “libpq is too old”


Then you will see this warning, and pdo_pgsql hook will not work.
If you need this support:
  * Enable PHP [pdo extension](https://www.php.net/manual/en/pdo.setup.php) 
  * [Install libpq](https://www.postgresql.org/download/)


If you don’t need this support, you can add an ini configuration:
```
swow.hook_pdo_pgsql = Off;

```
```

--------------------------------

### Swow API Documentation Overview

Source: https://docs.toast.run/swow/en/index

Lists key classes and namespaces within the Swow library, providing links to detailed API documentation for each component.

```APIDOC
Swow API Documentation:

Namespaces and Classes:
- Swow\Stream\StreamException
- Swow\Stream\VarStream
- Swow\Stream\MaxMessageLengthTrait
- Swow\Sync\WaitGroup
- Swow\Sync\WaitReference
- Swow\Utils\Handler
- Swow\WebSocket\Header
- Swow\WebSocket\Opcode
- Swow\WebSocket\Status
- Swow\WebSocket\WebSocket
- Swow (Root Class)
```

--------------------------------

### micro Wiki EN

Source: https://docs.toast.run/swow/en/tools

English documentation for the micro project, covering its functionality, configuration, and extension capabilities.

```APIDOC
How micro work
SAPI Interface
INI Configuration
Section Settings
How to add an extension into micro.sfx
```

--------------------------------

### Initialize SDB Debugger

Source: https://docs.toast.run/swow/en/tools/sdb

This snippet shows how to integrate the SDB debugger into your PHP code by calling the `runOnTTY` method. This prepares the debugger to be activated when the script is run with the `-e` flag.

```PHP
\Swow\Debug\Debugger\Debugger::runOnTTY();
```

--------------------------------

### Swow PSR-7 Server Classes

Source: https://docs.toast.run/swow/en/install

Documentation for classes within the Swow PSR-7 Server namespace, covering server broadcasting, event drivers, connection management, and server implementations.

```APIDOC
Class Swow\Psr7\Server\BroadcastResult
Class Swow\Psr7\Server\EventDriver
Class Swow\Psr7\Server\FilteredServerConnectionIterator
Class Swow\Psr7\Server\Server
Class Swow\Psr7\Server\ServerConnection
Class Swow\Psr7\Server\ServerConnectionIterator
```

--------------------------------

### Swow Builder Configuration Arguments

Source: https://docs.toast.run/swow/en/install

Lists configuration arguments for the `swow-builder` tool, including their aliases, types, platform compatibility, and descriptions. These arguments control various aspects of the Swow extension's compilation and features.

```APIDOC
Option | Alias in Builder | Type | Platform | Description
---|---|---|---|---
`--with-php-config=<path>` | `--php-config=<path>` |  |  | 指定`php-config`路径
`--enable-debug` |  | PHP |  | 打开PHP的调试模式，需要在**编译PHP时** 指定，在编译Swow时指定无效
`--enable-swow` |  |  |  | 启用Swow扩展的编译（默认启用）
`--enable-debug-pack` |  |  | Windows | 打开扩展的的debug pack构建，用于Windows下Release版本PHP的Swow调试，**编译Swow时** 指定，不能与`--enable-debug`一同使用
`--enable-swow-debug` | `--debug` |  |  | 启用DEBUG编译
`--eanble-swow-memory-sanitizer` | `--msan` | Debug | Unix-like | 启用`memory-sanitizer`帮助底层进行内存分析
`--enable-swow-address-sanitizer` | `--asan` | Debug | Unix-like | 启用`address-sanitizer`帮助底层进行内存分析
`--enable-swow-undefined-sanitizer` | `--ubsan` | Debug | Unix-like | 启用`undefined-sanitizer`帮助底层进行未定义行为分析
`--enable-swow-gcov` | `--gcov` | Debug | Unix-like | 启用GCOV支持，用于支持统计C代码覆盖率
`--enable-swow-valgrind` | `--valgrind` | Debug | Linux | 启用Valgrind支持（默认检测到有则自动启用）
`--enable-swow-thread-context` | `--thread-context` |  |  | 使用线程而不是`boost-context`作为协程上下文管理
`--enable-swow-ssl` | `--ssl` |  |  | 启用SSL支持，需要`OpenSSL`（默认检测到有则自动启用）
`--enable-swow-curl` | `--curl` |  |  | 启用cURL支持，需要`libcurl`（默认检测到有则自动启用）
```

--------------------------------

### Swow Tools

Source: https://docs.toast.run/swow/en/tools

Documentation for tools related to the Swow project, specifically mentioning SDB.

```APIDOC
SDB
```

--------------------------------

### Swow PSR-7 Server Interfaces

Source: https://docs.toast.run/swow/en/install

Documentation for interfaces related to server connections and iterators within the Swow PSR-7 Server namespace.

```APIDOC
Interface Swow\Psr7\Server\ServerConnectionFactoryInterface
Interface Swow\Psr7\Server\ServerConnectionIteratorInterface
```

--------------------------------

### Swow PSR-7 Server Classes

Source: https://docs.toast.run/swow/en/tools/sdb

Documentation for classes within the Swow PSR-7 Server namespace, covering server broadcasting, event drivers, connection management, and server implementations.

```APIDOC
Class Swow\Psr7\Server\BroadcastResult
Class Swow\Psr7\Server\EventDriver
Class Swow\Psr7\Server\FilteredServerConnectionIterator
Class Swow\Psr7\Server\Server
Class Swow\Psr7\Server\ServerConnection
Class Swow\Psr7\Server\ServerConnectionIterator
```

--------------------------------

### Swow Psr7 Client Classes and Interface

Source: https://docs.toast.run/swow/en/install

Detailed API documentation for the Swow Psr7 Client namespace, covering client-related classes and exceptions for network operations.

```APIDOC
Client: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/Client.html
ClientExceptionAbstract: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientExceptionAbstract.html
ClientNetworkException: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientNetworkException.html
ClientRequestException: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientRequestException.html
ClientExceptionInterface: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientExceptionInterface.html
```

--------------------------------

### Swow PSR-7 Server Traits

Source: https://docs.toast.run/swow/en/install

Documentation for traits used in the Swow PSR-7 Server namespace, providing factory, connection management, and server parameter functionalities.

```APIDOC
Trait Swow\Psr7\Server\ServerConnectionFactoryTrait
Trait Swow\Psr7\Server\ServerConnectionManagerTrait
Trait Swow\Psr7\Server\ServerParamsTrait
```

--------------------------------

### Customizing SDB Activation Key

Source: https://docs.toast.run/swow/en/tools/sdb

This snippet illustrates how to customize the key combination used to invoke the SDB debugger during runtime. By passing a string argument to `runOnTTY`, you can define a unique activation sequence.

```PHP
\Swow\Debug\Debugger\Debugger::runOnTTY('swow');
```

--------------------------------

### Swow PSR-7 Utilities Traits

Source: https://docs.toast.run/swow/en/install

Documentation for various utility traits within the Swow PSR-7 namespace, including conversion, creation, detection, factory, and operator functionalities.

```APIDOC
Trait Swow\Psr7\Utils\ConverterTrait
Trait Swow\Psr7\Utils\CreatorTrait
Trait Swow\Psr7\Utils\DetectorTrait
Trait Swow\Psr7\Utils\FactoryTrait
Trait Swow\Psr7\Utils\OperatorTrait
```

--------------------------------

### Swow API Documentation

Source: https://docs.toast.run/swow/en/tools

API documentation for the Swow project, detailing classes and namespaces. This includes Stream, Sync, Utils, and WebSocket related components.

```APIDOC
Namespace Swow\Stream:
  Class Swow\Stream\StreamException
  Class Swow\Stream\VarStream
  Trait Swow\Stream\MaxMessageLengthTrait

Namespace Swow\Sync:
  Class Swow\Sync\WaitGroup
  Class Swow\Sync\WaitReference

Namespace Swow\Utils:
  Class Swow\Utils\Handler

Namespace Swow\WebSocket:
  Class Swow\WebSocket\Header
  Class Swow\WebSocket\Opcode
  Class Swow\WebSocket\Status
  Class Swow\WebSocket\WebSocket

Namespace Swow:
  Class Swow
```

--------------------------------

### Micro Wiki - Section Settings

Source: https://docs.toast.run/swow/en/index

Information on managing section settings within the micro framework.

```en
Section Settings
```

--------------------------------

### Swow Http Namespace

Source: https://docs.toast.run/swow/en/install

API documentation for the Swow Http namespace, covering core HTTP classes like Http, Parser, ParserException, and Status.

```APIDOC
Http: https://docs.toast.run/swow-api/ci/Swow/Http/Http.html
Parser: https://docs.toast.run/swow-api/ci/Swow/Http/Parser.html
ParserException: https://docs.toast.run/swow-api/ci/Swow/Http/ParserException.html
Status: https://docs.toast.run/swow-api/ci/Swow/Http/Status.html
```

--------------------------------

### Swow PSR-7 Protocol Namespace

Source: https://docs.toast.run/swow/en/install

Documentation for the Swow PSR-7 Protocol namespace, specifically detailing the WebSocketTrait for handling WebSocket communication.

```APIDOC
Namespace Swow\Psr7\Protocol
  Trait Swow\Psr7\Protocol\WebSocketTrait
```

--------------------------------

### Swow Psr7 Client Namespace API Documentation

Source: https://docs.toast.run/swow/en/tools

Documentation for classes and interfaces related to PSR-7 HTTP client implementations.

```APIDOC
Client:
  Description: Represents an HTTP client implementing PSR-7.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/Client.html

ClientExceptionAbstract:
  Description: Abstract base class for client-related exceptions.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientExceptionAbstract.html

ClientNetworkException:
  Description: Exception for network-related client errors.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientNetworkException.html

ClientRequestException:
  Description: Exception for errors during client requests.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientRequestException.html

ClientExceptionInterface:
  Description: Interface for all client exceptions.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientExceptionInterface.html
```

--------------------------------

### Swow Psr7 Client Classes and Interface

Source: https://docs.toast.run/swow/en/tools/sdb

Detailed API documentation for the Swow Psr7 Client namespace, covering client-related classes and exceptions for network operations.

```APIDOC
Client: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/Client.html
ClientExceptionAbstract: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientExceptionAbstract.html
ClientNetworkException: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientNetworkException.html
ClientRequestException: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientRequestException.html
ClientExceptionInterface: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientExceptionInterface.html
```

--------------------------------

### Swow Psr7 Client Namespace API Documentation

Source: https://docs.toast.run/swow/en/index

Documentation for classes and interfaces related to PSR-7 HTTP client implementations.

```APIDOC
Client:
  Description: Represents an HTTP client implementing PSR-7.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/Client.html

ClientExceptionAbstract:
  Description: Abstract base class for client-related exceptions.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientExceptionAbstract.html

ClientNetworkException:
  Description: Exception for network-related client errors.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientNetworkException.html

ClientRequestException:
  Description: Exception for errors during client requests.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientRequestException.html

ClientExceptionInterface:
  Description: Interface for all client exceptions.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Client/ClientExceptionInterface.html
```

--------------------------------

### Swow PSR-7 Message Classes

Source: https://docs.toast.run/swow/en/tools

Documentation for core PSR-7 message-related classes in Swow, including Request, Response, ServerRequest, and their supporting components like BufferStream and Uri.

```APIDOC
Class Swow\Psr7\Message\AbstractMessage
Class Swow\Psr7\Message\BodyDecoder
Class Swow\Psr7\Message\BodyEncoder
Class Swow\Psr7\Message\BufferStream
Class Swow\Psr7\Message\PhpStream
Class Swow\Psr7\Message\Psr17Factory
Class Swow\Psr7\Message\Request
Class Swow\Psr7\Message\Response
Class Swow\Psr7\Message\ServerRequest
Class Swow\Psr7\Message\UpgradeType
Class Swow\Psr7\Message\UploadedFile
Class Swow\Psr7\Message\Uri
Class Swow\Psr7\Message\WebSocketFrame
```

--------------------------------

### Swow Psr7 Classes

Source: https://docs.toast.run/swow/en/install

Overview of classes within the Swow Psr7 namespace, including the main Psr7 class for PSR7 compliance.

```APIDOC
Psr7: https://docs.toast.run/swow-api/ci/Swow/Psr7/Psr7.html
```

--------------------------------

### Swow PSR-7 Message Classes

Source: https://docs.toast.run/swow/en/index

Documentation for core PSR-7 message-related classes in Swow, including Request, Response, ServerRequest, and their supporting components like BufferStream and Uri.

```APIDOC
Class Swow\Psr7\Message\AbstractMessage
Class Swow\Psr7\Message\BodyDecoder
Class Swow\Psr7\Message\BodyEncoder
Class Swow\Psr7\Message\BufferStream
Class Swow\Psr7\Message\PhpStream
Class Swow\Psr7\Message\Psr17Factory
Class Swow\Psr7\Message\Request
Class Swow\Psr7\Message\Response
Class Swow\Psr7\Message\ServerRequest
Class Swow\Psr7\Message\UpgradeType
Class Swow\Psr7\Message\UploadedFile
Class Swow\Psr7\Message\Uri
Class Swow\Psr7\Message\WebSocketFrame
```

--------------------------------

### Swow PSR-7 Server Interfaces

Source: https://docs.toast.run/swow/en/tools/sdb

Documentation for interfaces related to server connections and iterators within the Swow PSR-7 Server namespace.

```APIDOC
Interface Swow\Psr7\Server\ServerConnectionFactoryInterface
Interface Swow\Psr7\Server\ServerConnectionIteratorInterface
```

--------------------------------

### Swow Psr7 Config Traits

Source: https://docs.toast.run/swow/en/install

Documentation for the Swow Psr7 Config namespace, featuring the LimitationTrait for configuration limitations.

```APIDOC
LimitationTrait: https://docs.toast.run/swow-api/ci/Swow/Psr7/Config/LimitationTrait.html
```

--------------------------------

### Swow PSR-7 Server Traits

Source: https://docs.toast.run/swow/en/tools/sdb

Documentation for traits used in the Swow PSR-7 Server namespace, providing factory, connection management, and server parameter functionalities.

```APIDOC
Trait Swow\Psr7\Server\ServerConnectionFactoryTrait
Trait Swow\Psr7\Server\ServerConnectionManagerTrait
Trait Swow\Psr7\Server\ServerParamsTrait
```

--------------------------------

### Swow PSR-7 Server Classes

Source: https://docs.toast.run/swow/en/tools

Documentation for classes related to server-side operations in Swow's PSR-7 implementation, including server management and connection handling.

```APIDOC
Class Swow\Psr7\Server\BroadcastResult
Class Swow\Psr7\Server\EventDriver
Class Swow\Psr7\Server\FilteredServerConnectionIterator
Class Swow\Psr7\Server\Server
Class Swow\Psr7\Server\ServerConnection
Class Swow\Psr7\Server\ServerConnectionIterator
```

--------------------------------

### micro Wiki CHS

Source: https://docs.toast.run/swow/en/tools

Chinese documentation for the micro project, covering its functionality, configuration, and extension capabilities.

```APIDOC
micro是什么
micro怎么工作
SAPI接口
INI配置
Section设置
如何在micro中加入一个PHP扩展
```

--------------------------------

### Swow PSR-7 Utilities Traits

Source: https://docs.toast.run/swow/en/index

Documentation for various utility traits in Swow's PSR-7 implementation, offering functionalities for conversion, creation, detection, factory operations, and general operators.

```APIDOC
Trait Swow\Psr7\Utils\ConverterTrait
Trait Swow\Psr7\Utils\CreatorTrait
Trait Swow\Psr7\Utils\DetectorTrait
Trait Swow\Psr7\Utils\FactoryTrait
Trait Swow\Psr7\Utils\OperatorTrait
```

--------------------------------

### Swow PSR-7 Utilities Traits

Source: https://docs.toast.run/swow/en/tools

Documentation for various utility traits in Swow's PSR-7 implementation, offering functionalities for conversion, creation, detection, factory operations, and general operators.

```APIDOC
Trait Swow\Psr7\Utils\ConverterTrait
Trait Swow\Psr7\Utils\CreatorTrait
Trait Swow\Psr7\Utils\DetectorTrait
Trait Swow\Psr7\Utils\FactoryTrait
Trait Swow\Psr7\Utils\OperatorTrait
```

--------------------------------

### Swow PSR-7 Server Classes

Source: https://docs.toast.run/swow/en/index

Documentation for classes related to server-side operations in Swow's PSR-7 implementation, including server management and connection handling.

```APIDOC
Class Swow\Psr7\Server\BroadcastResult
Class Swow\Psr7\Server\EventDriver
Class Swow\Psr7\Server\FilteredServerConnectionIterator
Class Swow\Psr7\Server\Server
Class Swow\Psr7\Server\ServerConnection
Class Swow\Psr7\Server\ServerConnectionIterator
```

--------------------------------

### Swow Http Namespace API Documentation

Source: https://docs.toast.run/swow/en/tools

Documentation for core classes within the Swow Http namespace, covering HTTP protocol basics and parsing.

```APIDOC
Http:
  Description: Represents core HTTP functionalities.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Http.html

Parser:
  Description: Handles the parsing of HTTP messages.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Parser.html

ParserException:
  Description: Exception class specifically for HTTP parsing errors.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/ParserException.html

Status:
  Description: Defines HTTP status codes and related information.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Status.html
```

--------------------------------

### Swow Pack Classes

Source: https://docs.toast.run/swow/en/install

API documentation for the Swow Pack namespace, specifically the Format class used for data packing.

```APIDOC
Format: https://docs.toast.run/swow-api/ci/Swow/Pack/Format.html
```

--------------------------------

### Swow Http Namespace API Documentation

Source: https://docs.toast.run/swow/en/index

Documentation for core classes within the Swow Http namespace, covering HTTP protocol basics and parsing.

```APIDOC
Http:
  Description: Represents core HTTP functionalities.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Http.html

Parser:
  Description: Handles the parsing of HTTP messages.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Parser.html

ParserException:
  Description: Exception class specifically for HTTP parsing errors.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/ParserException.html

Status:
  Description: Defines HTTP status codes and related information.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Status.html
```

--------------------------------

### Swow Http Namespace

Source: https://docs.toast.run/swow/en/tools/sdb

API documentation for the Swow Http namespace, covering core HTTP classes like Http, Parser, ParserException, and Status.

```APIDOC
Http: https://docs.toast.run/swow-api/ci/Swow/Http/Http.html
Parser: https://docs.toast.run/swow-api/ci/Swow/Http/Parser.html
ParserException: https://docs.toast.run/swow-api/ci/Swow/Http/ParserException.html
Status: https://docs.toast.run/swow-api/ci/Swow/Http/Status.html
```

--------------------------------

### Swow PSR-7 Server Interfaces

Source: https://docs.toast.run/swow/en/index

Documentation for interfaces defining the contracts for server connections and iterators within Swow's PSR-7 server implementation.

```APIDOC
Interface Swow\Psr7\Server\ServerConnectionFactoryInterface
Interface Swow\Psr7\Server\ServerConnectionIteratorInterface
```

--------------------------------

### Swow PSR-7 Server Interfaces

Source: https://docs.toast.run/swow/en/tools

Documentation for interfaces defining the contracts for server connections and iterators within Swow's PSR-7 server implementation.

```APIDOC
Interface Swow\Psr7\Server\ServerConnectionFactoryInterface
Interface Swow\Psr7\Server\ServerConnectionIteratorInterface
```

--------------------------------

### Swow PSR-7 Server Traits

Source: https://docs.toast.run/swow/en/tools

Documentation for traits providing common server functionalities in Swow's PSR-7 implementation, such as connection management and parameter handling.

```APIDOC
Trait Swow\Psr7\Server\ServerConnectionFactoryTrait
Trait Swow\Psr7\Server\ServerConnectionManagerTrait
Trait Swow\Psr7\Server\ServerParamsTrait
```

--------------------------------

### Swow API Reference - Namespace Swow\Context Classes

Source: https://docs.toast.run/swow/en/tools

This section lists the classes available within the Swow\Context namespace in the Swow API Reference. It provides links to detailed documentation for each class, covering their methods, properties, and usage.

```APIDOC
Namespace Swow\Context:
  Class Swow\Context\Context
  Class Swow\Context\CoroutineContext
```

--------------------------------

### Swow PSR-7 Server Traits

Source: https://docs.toast.run/swow/en/index

Documentation for traits providing common server functionalities in Swow's PSR-7 implementation, such as connection management and parameter handling.

```APIDOC
Trait Swow\Psr7\Server\ServerConnectionFactoryTrait
Trait Swow\Psr7\Server\ServerConnectionManagerTrait
Trait Swow\Psr7\Server\ServerParamsTrait
```

--------------------------------

### Swow Http Protocol Namespace API Documentation

Source: https://docs.toast.run/swow/en/tools

Documentation for classes and traits related to HTTP protocol handling and data reception.

```APIDOC
ProtocolException:
  Description: Exception class for HTTP protocol errors.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ProtocolException.html

ProtocolTypeInterface:
  Description: Interface defining protocol type functionalities.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ProtocolTypeInterface.html

ProtocolTypeTrait:
  Description: Trait providing protocol type related methods.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ProtocolTypeTrait.html

ReceiverTrait:
  Description: Trait for handling data reception in protocols.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ReceiverTrait.html
```

--------------------------------

### Swow Http Protocol Namespace API Documentation

Source: https://docs.toast.run/swow/en/index

Documentation for classes and traits related to HTTP protocol handling and data reception.

```APIDOC
ProtocolException:
  Description: Exception class for HTTP protocol errors.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ProtocolException.html

ProtocolTypeInterface:
  Description: Interface defining protocol type functionalities.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ProtocolTypeInterface.html

ProtocolTypeTrait:
  Description: Trait providing protocol type related methods.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ProtocolTypeTrait.html

ReceiverTrait:
  Description: Trait for handling data reception in protocols.
  Link: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ReceiverTrait.html
```

--------------------------------

### Running PHP with SDB

Source: https://docs.toast.run/swow/en/tools/sdb

This command demonstrates how to execute a PHP script with the SDB debugger enabled. The `-e` flag activates the embedded debugger, and `-d extension=swow` ensures the Swow extension is loaded.

```bash
php -e -d extension=swow index.php
```

--------------------------------

### Swow PSR-7 Utilities Traits

Source: https://docs.toast.run/swow/en/tools/sdb

Documentation for various utility traits within the Swow PSR-7 namespace, including conversion, creation, detection, factory, and operator functionalities.

```APIDOC
Trait Swow\Psr7\Utils\ConverterTrait
Trait Swow\Psr7\Utils\CreatorTrait
Trait Swow\Psr7\Utils\DetectorTrait
Trait Swow\Psr7\Utils\FactoryTrait
Trait Swow\Psr7\Utils\OperatorTrait
```

--------------------------------

### Swow API Reference - Namespace Swow\Context

Source: https://docs.toast.run/swow/en/tools/sdb

Documentation for classes within the Swow\Context namespace, focusing on context management for coroutines.

```APIDOC
Namespace Swow\Context:
  Class Swow\Context\Context
  Class Swow\Context\CoroutineContext
```

--------------------------------

### Swow Psr7 Namespace API Documentation

Source: https://docs.toast.run/swow/en/tools

Documentation for the core Psr7 class, likely an adapter or utility for PSR-7 HTTP message interfaces.

```APIDOC
Psr7:
  Description: Utility class for PSR-7 HTTP message handling.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Psr7.html
```

--------------------------------

### Swow Psr7 Namespace API Documentation

Source: https://docs.toast.run/swow/en/index

Documentation for the core Psr7 class, likely an adapter or utility for PSR-7 HTTP message interfaces.

```APIDOC
Psr7:
  Description: Utility class for PSR-7 HTTP message handling.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Psr7.html
```

--------------------------------

### Swow PSR-7 Protocol Namespace

Source: https://docs.toast.run/swow/en/tools/sdb

Documentation for the Swow PSR-7 Protocol namespace, specifically detailing the WebSocketTrait for handling WebSocket communication.

```APIDOC
Namespace Swow\Psr7\Protocol
  Trait Swow\Psr7\Protocol\WebSocketTrait
```

--------------------------------

### Swow Exception Namespace

Source: https://docs.toast.run/swow/en/install

Documentation for the Swow Exception namespace, including classes and traits related to exception handling and manipulation.

```APIDOC
ExceptionEditor: https://docs.toast.run/swow-api/ci/Swow/Exception/ExceptionEditor.html
ExceptionFakerTrait: https://docs.toast.run/swow-api/ci/Swow/Exception/ExceptionFakerTrait.html
```

--------------------------------

### Swow PSR-7 Message Classes

Source: https://docs.toast.run/swow/en/install

Documentation for core PSR-7 message-related classes in the Swow project. This includes abstract message handling, body decoding and encoding, buffer and stream management, request/response objects, and URI handling.

```APIDOC
Class Swow\Psr7\Message\AbstractMessage
Class Swow\Psr7\Message\BodyDecoder
Class Swow\Psr7\Message\BodyEncoder
Class Swow\Psr7\Message\BufferStream
Class Swow\Psr7\Message\PhpStream
Class Swow\Psr7\Message\Psr17Factory
Class Swow\Psr7\Message\Request
Class Swow\Psr7\Message\Response
Class Swow\Psr7\Message\ServerRequest
Class Swow\Psr7\Message\UpgradeType
Class Swow\Psr7\Message\UploadedFile
Class Swow\Psr7\Message\Uri
Class Swow\Psr7\Message\WebSocketFrame
```

--------------------------------

### Swow Pack Namespace API Documentation

Source: https://docs.toast.run/swow/en/tools

Documentation for the Format class, likely related to data packing or serialization formats.

```APIDOC
Format:
  Description: Class for handling data formats.
  Link: https://docs.toast.run/swow-api/ci/Swow/Pack/Format.html
```

--------------------------------

### Swow Psr7 Config Namespace API Documentation

Source: https://docs.toast.run/swow/en/tools

Documentation for the LimitationTrait, likely used for configuring request limitations.

```APIDOC
LimitationTrait:
  Description: Trait for managing request limitations.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Config/LimitationTrait.html
```

--------------------------------

### Swow Psr7 Config Namespace API Documentation

Source: https://docs.toast.run/swow/en/index

Documentation for the LimitationTrait, likely used for configuring request limitations.

```APIDOC
LimitationTrait:
  Description: Trait for managing request limitations.
  Link: https://docs.toast.run/swow-api/ci/Swow/Psr7/Config/LimitationTrait.html
```

--------------------------------

### Swow Event-Driven Architecture

Source: https://docs.toast.run/swow/en/index

Swow is built upon libcat, which in turn uses libuv, providing an industry-level event loop driver. This enables efficient asynchronous event handling across various operating systems, including native Windows support via IOCP.

```APIDOC
Swow Event-Driven Architecture:
  - Core: libcat
  - Underlying Event Library: libuv
  - Event Loop Driver: Industry-level proven, supports Proactor model.
  - Operating System Support: All common OS, including native Windows support via IOCP.
  - Future Enhancements: Potential performance improvements from io_uring on Linux.
  - Programming Model: Coroutine-based asynchronous event handling.
```

--------------------------------

### Swow PSR-7 Utilities Traits

Source: https://docs.toast.run/swow/en/faq

Documentation for various utility traits in Swow's PSR-7 implementation, offering functionalities for conversion, creation, detection, factory operations, and general operators.

```APIDOC
Trait Swow\Psr7\Utils\ConverterTrait
Trait Swow\Psr7\Utils\CreatorTrait
Trait Swow\Psr7\Utils\DetectorTrait
Trait Swow\Psr7\Utils\FactoryTrait
Trait Swow\Psr7\Utils\OperatorTrait
```

--------------------------------

### Swow Pack Namespace API Documentation

Source: https://docs.toast.run/swow/en/index

Documentation for the Format class, likely related to data packing or serialization formats.

```APIDOC
Format:
  Description: Class for handling data formats.
  Link: https://docs.toast.run/swow-api/ci/Swow/Pack/Format.html
```

--------------------------------

### Swow Http Protocol Interfaces and Traits

Source: https://docs.toast.run/swow/en/install

API references for the Swow Http Protocol namespace, including ProtocolException, ProtocolTypeInterface, ProtocolTypeTrait, and ReceiverTrait.

```APIDOC
ProtocolException: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ProtocolException.html
ProtocolTypeInterface: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ProtocolTypeInterface.html
ProtocolTypeTrait: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ProtocolTypeTrait.html
ReceiverTrait: https://docs.toast.run/swow-api/ci/Swow/Http/Protocol/ReceiverTrait.html
```

--------------------------------

### Swow PSR-7 Message Classes

Source: https://docs.toast.run/swow/en/faq

Documentation for core PSR-7 message-related classes in Swow, including Request, Response, ServerRequest, and their supporting components like BufferStream and Uri.

```APIDOC
Class Swow\Psr7\Message\AbstractMessage
Class Swow\Psr7\Message\BodyDecoder
Class Swow\Psr7\Message\BodyEncoder
Class Swow\Psr7\Message\BufferStream
Class Swow\Psr7\Message\PhpStream
Class Swow\Psr7\Message\Psr17Factory
Class Swow\Psr7\Message\Request
Class Swow\Psr7\Message\Response
Class Swow\Psr7\Message\ServerRequest
Class Swow\Psr7\Message\UpgradeType
Class Swow\Psr7\Message\UploadedFile
Class Swow\Psr7\Message\Uri
Class Swow\Psr7\Message\WebSocketFrame
```

--------------------------------

### Swow PSR-7 Server Traits

Source: https://docs.toast.run/swow/en/faq

Documentation for traits providing common server functionalities in Swow's PSR-7 implementation, such as connection management and parameter handling.

```APIDOC
Trait Swow\Psr7\Server\ServerConnectionFactoryTrait
Trait Swow\Psr7\Server\ServerConnectionManagerTrait
Trait Swow\Psr7\Server\ServerParamsTrait
```

--------------------------------

### Swow API Reference - Namespace Swow\Context Classes

Source: https://docs.toast.run/swow/en/install

Details the classes within the Swow\Context namespace, focusing on context management for coroutines.

```APIDOC
Namespace Swow\Context:
  Class Swow\Context\Context
  Class Swow\Context\CoroutineContext
```

--------------------------------

### Swow PSR-7 Server Classes

Source: https://docs.toast.run/swow/en/faq

Documentation for classes related to server-side operations in Swow's PSR-7 implementation, including server management and connection handling.

```APIDOC
Class Swow\Psr7\Server\BroadcastResult
Class Swow\Psr7\Server\EventDriver
Class Swow\Psr7\Server\FilteredServerConnectionIterator
Class Swow\Psr7\Server\Server
Class Swow\Psr7\Server\ServerConnection
Class Swow\Psr7\Server\ServerConnectionIterator
```

--------------------------------

### Swow API Reference - Namespace Swow\Debug\Debugger Classes

Source: https://docs.toast.run/swow/en/install

Provides an overview of the classes related to debugging functionalities within the Swow\Debug\Debugger namespace, including debugger context, commands, and I/O handling.

```APIDOC
Namespace Swow\Debug\Debugger:
  Class Swow\Debug\Debugger\DebugContext
  Class Swow\Debug\Debugger\Debugger
  Class Swow\Debug\Debugger\DebuggerCommandContext
  Class Swow\Debug\Debugger\DebuggerException
  Class Swow\Debug\Debugger\DebuggerHelper
  Class Swow\Debug\Debugger\DebuggerIoEofStream
  Class Swow\Debug\Debugger\DebuggerIoStdIO
  Interface Swow\Debug\Debugger\DebuggerIoInterface
```

--------------------------------

### Swow PSR-7 Message Traits

Source: https://docs.toast.run/swow/en/tools

Documentation for traits used in Swow's PSR-7 message implementation, providing reusable functionality for factories and message handling.

```APIDOC
Trait Swow\Psr7\Message\ClientPsr17FactoryTrait
Trait Swow\Psr7\Message\MessagePsr17FactoryTrait
Trait Swow\Psr7\Message\ServerPsr17FactoryTrait
```

--------------------------------

### Swow PSR-7 Server Interfaces

Source: https://docs.toast.run/swow/en/faq

Documentation for interfaces defining the contracts for server connections and iterators within Swow's PSR-7 server implementation.

```APIDOC
Interface Swow\Psr7\Server\ServerConnectionFactoryInterface
Interface Swow\Psr7\Server\ServerConnectionIteratorInterface
```
Tokens:
Raw