Swoole

• 简介
• 安装/配置
  • 安装
  • 运行时配置
• 预定义常量
• Swoole函数
  • swoole_async_dns_lookup — 异步非阻塞主机名到IP查找
  • swoole_async_read — 异步读取文件流
  • swoole_async_readfile — 异步读取文件
  • swoole_async_set — 更新异步I/O选项
  • swoole_async_write — 异步写入数据到文件流
  • swoole_async_writefile — 异步写入数据到文件
  • swoole_clear_error — 清除套接字或上次错误代码中的错误
  • swoole_client_select — 获取准备好读/写或出错的文件描述符
  • swoole_cpu_num — 获取CPU数量
  • swoole_errno — 获取最新系统调用的错误代码
  • swoole_error_log — 将错误消息输出到日志
  • swoole_event_add — 将套接字的新回调函数添加到EventLoop
  • swoole_event_defer — 将回调函数添加到下一个事件循环
  • swoole_event_del — 删除套接字的所有事件回调函数
  • swoole_event_exit — 退出事件循环，仅在客户端可用
  • swoole_event_set — 更新套接字的事件回调函数
  • swoole_event_wait — 启动事件循环
  • swoole_event_write — 向套接字写入数据
  • swoole_get_local_ip — 获取机器上每个网卡的IPv4 IP地址
  • swoole_last_error — 获取最新的错误消息
  • swoole_load_module — 加载Swoole扩展
  • swoole_select — 在事件循环中选择准备好读/写或出错的文件描述符
  • swoole_set_process_name — 设置进程名称
  • swoole_strerror — 将Errno转换为错误消息
  • swoole-timer-after — 在未来触发一次性回调函数
  • swoole_timer_exists — 检查计时器回调函数是否存在
  • swoole_timer_tick — 按时间间隔触发计时器周期回调函数
  • swoole_version — 获取Swoole的版本
• Swoole\Async — Swoole\Async类
  • Swoole\Async::dnsLookup — 异步非阻塞主机名到IP查找。
  • Swoole\Async::read — 异步读取文件流。
  • Swoole\Async::readFile — 异步读取文件。
  • Swoole\Async::set — 更新异步I/O选项。
  • Swoole\Async::write — 异步写入数据到文件流。
  • Swoole\Async::writeFile — 说明
• Swoole\Atomic — Swoole\Atomic类
  • Swoole\Atomic::add — 将一个数字添加到原子对象的数值。
  • Swoole\Atomic::cmpset — 比较并设置原子对象的数值。
  • Swoole\Atomic::__construct — 构造一个Swoole原子对象。
  • Swoole\Atomic::get — 获取原子对象的当前值。
  • Swoole\Atomic::set — 为原子对象设置一个新值。
  • Swoole\Atomic::sub — 从原子对象的数值中减去一个数字。
• Swoole\Buffer — Swoole\Buffer类
  • Swoole\Buffer::append — 将字符串或二进制数据追加到内存缓冲区的末尾，并返回分配的新内存大小。
  • Swoole\Buffer::clear — 重置内存缓冲区。
  • Swoole\Buffer::__construct — 固定大小内存块分配。
  • Swoole\Buffer::__destruct — 销毁Swoole内存缓冲区。
  • Swoole\Buffer::expand — 扩展内存缓冲区的大小。
  • Swoole\Buffer::read — 基于偏移量和长度从内存缓冲区读取数据。
  • Swoole\Buffer::recycle — 将内存缓冲区未使用的内存释放给操作系统。
  • Swoole\Buffer::substr — 基于偏移量和长度从内存缓冲区读取数据。或者从内存缓冲区移除数据。
  • Swoole\Buffer::__toString — 获取内存缓冲区的字符串值。
  • Swoole\Buffer::write — 将数据写入内存缓冲区。为缓冲区分配的内存不会改变。
• Swoole\Channel — Swoole\Channel类
  • Swoole\Channel::__construct — 构造一个Swoole Channel
  • Swoole\Channel::__destruct — 销毁Swoole channel。
  • Swoole\Channel::pop — 从Swoole channel读取并弹出数据。
  • Swoole\Channel::push — 将数据写入并推送到Swoole channel。
  • Swoole\Channel::stats — 获取Swoole channel的统计信息。
• Swoole\Client — Swoole\Client类
  • Swoole\Client::close — 关闭已建立的连接。
  • Swoole\Client::connect — 连接到远程TCP或UDP端口。
  • Swoole\Client::__construct — 创建Swoole同步或异步TCP/UDP客户端，支持或不支持SSL。
  • Swoole\Client::__destruct — 销毁Swoole客户端。
  • Swoole\Client::getpeername — 获取连接的远程套接字名称。
  • Swoole\Client::getsockname — 获取连接的本地套接字名称。
  • Swoole\Client::isConnected — 检查连接是否已建立。
  • Swoole\Client::on — 添加由事件触发的回调函数。
  • Swoole\Client::pause — 暂停接收数据。
  • Swoole\Client::pipe — 将数据重定向到另一个文件描述符。
  • Swoole\Client::recv — 从远程套接字接收数据。
  • Swoole\Client::resume — 恢复接收数据。
  • Swoole\Client::send — 将数据发送到远程TCP套接字。
  • Swoole\Client::sendfile — 将文件发送到远程TCP套接字。
  • Swoole\Client::sendto — 将数据发送到远程UDP地址。
  • Swoole\Client::set — 在建立连接之前设置Swoole客户端参数。
  • Swoole\Client::sleep — 从系统事件循环中移除TCP客户端。
  • Swoole\Client::wakeup — 将TCP客户端添加回系统事件循环。
• Swoole\Connection\Iterator — Swoole\Connection\Iterator类
  • Swoole\Connection\Iterator::count — 统计连接数。
  • Swoole\Connection\Iterator::current — 返回当前连接条目。
  • Swoole\Connection\Iterator::key — 返回当前连接的键。
  • Swoole\Connection\Iterator::next — 移动到下一个连接。
  • Swoole\Connection\Iterator::offsetExists — 检查偏移量是否存在。
  • Swoole\Connection\Iterator::offsetGet — 获取偏移量。
  • Swoole\Connection\Iterator::offsetSet — 为指定的偏移量赋值一个 Connection 对象。
  • Swoole\Connection\Iterator::offsetUnset — 取消设置偏移量。
  • Swoole\Connection\Iterator::rewind — 重置迭代器。
  • Swoole\Connection\Iterator::valid — 检查当前位置是否有效。
• Swoole\Coroutine — Swoole\Coroutine 类
  • Swoole\Coroutine::call_user_func — 调用第一个参数指定的回调函数。
  • Swoole\Coroutine::call_user_func_array — 使用参数数组调用回调函数。
  • Swoole\Coroutine::cli_wait — 描述
  • Swoole\Coroutine::create — 描述
  • Swoole\Coroutine\Client::close — 描述
  • Swoole\Coroutine\Client::connect — 描述
  • Swoole\Coroutine\Client::__construct — 描述
  • Swoole\Coroutine\Client::__destruct — 描述
  • Swoole\Coroutine\Client::getpeername — 描述
  • Swoole\Coroutine\Client::getsockname — 描述
  • Swoole\Coroutine\Client::isConnected — 描述
  • Swoole\Coroutine\Client::recv — 描述
  • Swoole\Coroutine\Client::send — 描述
  • Swoole\Coroutine\Client::sendfile — 描述
  • Swoole\Coroutine\Client::sendto — 描述
  • Swoole\Coroutine\Client::set — 描述
  • Swoole\Coroutine\Http\Client::addFile — 描述
  • Swoole\Coroutine\Http\Client::close — 描述
  • Swoole\Coroutine\Http\Client::__construct — 描述
  • Swoole\Coroutine\Http\Client::__destruct — 描述
  • Swoole\Coroutine\Http\Client::execute — 描述
  • Swoole\Coroutine\Http\Client::get — 描述
  • Swoole\Coroutine\Http\Client::getDefer — 描述
  • Swoole\Coroutine\Http\Client::isConnected — 描述
  • Swoole\Coroutine\Http\Client::post — 描述
  • Swoole\Coroutine\Http\Client::recv — 描述
  • Swoole\Coroutine\Http\Client::set — 描述
  • Swoole\Coroutine\Http\Client::setCookies — 描述
  • Swoole\Coroutine\Http\Client::setData — 描述
  • Swoole\Coroutine\Http\Client::setDefer — 描述
  • Swoole\Coroutine\Http\Client::setHeaders — 描述
  • Swoole\Coroutine\Http\Client::setMethod — 描述
  • Swoole\Coroutine\MySQL::close — 描述
  • Swoole\Coroutine\MySQL::connect — 描述
  • Swoole\Coroutine\MySQL::__construct — 描述
  • Swoole\Coroutine\MySQL::__destruct — 描述
  • Swoole\Coroutine\MySQL::getDefer — 描述
  • Swoole\Coroutine\MySQL::query — 描述
  • Swoole\Coroutine\MySQL::recv — 描述
  • Swoole\Coroutine\MySQL::setDefer — 描述
  • Swoole\Coroutine::getuid — 描述
  • Swoole\Coroutine::resume — 描述
  • Swoole\Coroutine::suspend — 描述
• Swoole\Event — Swoole\Event 类
  • Swoole\Event::add — 将套接字的新回调函数添加到 EventLoop 中。
  • Swoole\Event::defer — 将回调函数添加到下一个事件循环。
  • Swoole\Event::del — 删除套接字的所有事件回调函数。
  • Swoole\Event::exit — 退出事件循环，仅在客户端可用。
  • Swoole\Event::set — 更新套接字的事件回调函数。
  • Swoole\Event::wait — 描述
  • Swoole\Event::write — 向套接字写入数据。
• Swoole\Exception — Swoole\Exception 类
• Swoole\Http\Client — Swoole\Http\Client 类
  • Swoole\Http\Client::addFile — 将文件添加到 POST 表单。
  • Swoole\Http\Client::close — 关闭 HTTP 连接。
  • Swoole\Http\Client::__construct — 构造异步 HTTP 客户端。
  • Swoole\Http\Client::__destruct — 析构 HTTP 客户端。
  • Swoole\Http\Client::download — 从远程服务器下载文件。
  • Swoole\Http\Client::execute — 设置参数后发送 HTTP 请求。
  • Swoole\Http\Client::get — 向远程服务器发送 GET HTTP 请求。
  • Swoole\Http\Client::isConnected — 检查 HTTP 连接是否已连接。
  • Swoole\Http\Client::on — 通过事件名称注册回调函数。
  • Swoole\Http\Client::post — 向远程服务器发送 POST HTTP 请求。
  • Swoole\Http\Client::push — 向 WebSocket 客户端推送数据。
  • Swoole\Http\Client::set — 更新 HTTP 客户端参数。
  • Swoole\Http\Client::setCookies — 设置 HTTP 请求 Cookie。
  • Swoole\Http\Client::setData — 设置 HTTP 请求正文数据。
  • Swoole\Http\Client::setHeaders — 设置 HTTP 请求头。
  • Swoole\Http\Client::setMethod — 设置 HTTP 请求方法。
  • Swoole\Http\Client::upgrade — 升级到 WebSocket 协议。
• Swoole\Http\Request — Swoole\Http\Request 类
  • Swoole\Http\Request::__destruct — 析构 HTTP 请求。
  • Swoole\Http\Request::rawcontent — 获取原始 HTTP POST 正文。
• Swoole\Http\Response — Swoole\Http\Response 类
  • Swoole\Http\Response::cookie — 设置 HTTP 响应的 Cookie。
  • Swoole\Http\Response::__destruct — 析构 HTTP 响应。
  • Swoole\Http\Response::end — 发送 HTTP 请求的数据并完成响应。
  • Swoole\Http\Response::gzip — 启用响应内容的 gzip 压缩。
  • Swoole\Http\Response::header — 设置 HTTP 响应头。
  • Swoole\Http\Response::initHeader — 初始化 HTTP 响应头。
  • Swoole\Http\Response::rawcookie — 将原始 Cookie 设置到 HTTP 响应。
  • Swoole\Http\Response::sendfile — 通过 HTTP 响应发送文件。
  • Swoole\Http\Response::status — 设置 HTTP 响应的状态码。
  • Swoole\Http\Response::write — 将 HTTP 正文内容追加到 HTTP 响应。
• Swoole\Http\Server — Swoole\Http\Server 类
  • Swoole\Http\Server::on — 通过事件名称将回调函数绑定到 HTTP 服务器。
  • Swoole\Http\Server::start — 启动 Swoole HTTP 服务器。
• Swoole\Lock — Swoole\Lock 类
  • Swoole\Lock::__construct — 构造内存锁。
  • Swoole\Lock::__destruct — 销毁 Swoole 内存锁。
  • Swoole\Lock::lock — 尝试获取锁。如果锁不可用，它将阻塞。
  • Swoole\Lock::lock_read — 以读模式锁定读写锁。
  • Swoole\Lock::trylock — 尝试获取锁，即使锁不可用也立即返回。
  • Swoole\Lock::trylock_read — 尝试以读模式锁定读写锁，即使锁不可用也立即返回。
  • Swoole\Lock::unlock — 释放锁。
• Swoole\Mmap — Swoole\Mmap 类
  • Swoole\Mmap::open — 将文件映射到内存中，并返回可用于 PHP 流操作的流资源。
• Swoole\MySQL — Swoole\MySQL 类
  • Swoole\MySQL::close — 关闭异步 MySQL 连接。
  • Swoole\MySQL::connect — 连接到远程 MySQL 服务器。
  • Swoole\MySQL::__construct — 构造异步 MySQL 客户端。
  • Swoole\MySQL::__destruct — 销毁异步 MySQL 客户端。
  • Swoole\MySQL::getBuffer — 描述
  • Swoole\MySQL::on — 基于事件名称注册回调函数。
  • Swoole\MySQL::query — 运行 SQL 查询。
• Swoole\MySQL\Exception — Swoole\MySQL\Exception 类
• Swoole\Process — Swoole\Process 类
  • Swoole\Process::alarm — 高精度定时器，以固定间隔触发信号。
  • Swoole\Process::close — 关闭到子进程的管道。
  • Swoole\Process::__construct — 构造一个进程。
  • Swoole\Process::daemon — 将进程更改为守护进程。
  • Swoole\Process::__destruct — 销毁进程。
  • Swoole\Process::exec — 执行系统命令。
  • Swoole\Process::exit — 停止子进程。
  • Swoole\Process::freeQueue — 销毁由 swoole_process::useQueue 创建的消息队列。
  • Swoole\Process::kill — 向子进程发送信号。
  • Swoole\Process::name — 设置进程名称。
  • Swoole\Process::pop — 从消息队列读取并弹出数据。
  • Swoole\Process::push — 将数据写入并推入消息队列。
  • Swoole\Process::read — 读取发送到进程的数据。
  • Swoole\Process::signal — 向子进程发送信号。
  • Swoole\Process::start — 启动进程。
  • Swoole\Process::statQueue — 获取用作进程间通信方法的消息队列的统计信息。
  • Swoole\Process::useQueue — 创建一个消息队列作为父进程和子进程之间通信的方法。
  • Swoole\Process::wait — 等待子进程的事件。
  • Swoole\Process::write — 将数据写入管道并与父进程或子进程通信。
• Swoole\Redis\Server — Swoole\Redis\Server 类
  • Swoole\Redis\Server::format — 描述
  • Swoole\Redis\Server::setHandler — 描述
  • Swoole\Redis\Server::start — 描述
• Swoole\Serialize — Swoole\Serialize 类
  • Swoole\Serialize::pack — 序列化数据。
  • Swoole\Serialize::unpack — 反序列化数据。
• Swoole\Server — Swoole\Server 类
  • Swoole\Server::addlistener — 向服务器添加新的监听器。
  • Swoole\Server::addProcess — 向服务器添加用户自定义的 swoole_process。
  • Swoole\Server::after — 一段时间后触发回调函数。
  • Swoole\Server::bind — 将连接绑定到用户定义的用户 ID。
  • Swoole\Server::clearTimer — 停止并销毁计时器。
  • Swoole\Server::close — 关闭与客户端的连接。
  • Swoole\Server::confirm — 检查连接状态。
  • Swoole\Server::connection_info — 通过文件描述符获取连接信息。
  • Swoole\Server::connection_list — 获取所有已建立的连接。
  • Swoole\Server::__construct — 构造 Swoole 服务器。
  • Swoole\Server::defer — 推迟在当前 EventLoop 结束时执行回调函数。
  • Swoole\Server\Port::__construct — 构造服务器端口
  • Swoole\Server\Port::__destruct — 销毁服务器端口
  • Swoole\Server\Port::on — 通过事件注册回调函数。
  • Swoole\Server\Port::set — 设置服务器端口的协议。
  • Swoole\Server::exist — 检查连接是否存在。
  • Swoole\Server::finish — 在任务进程中用于在任务完成后将结果发送到工作进程。
  • Swoole\Server::getClientInfo — 通过文件描述符获取连接信息。
  • Swoole\Server::getClientList — 获取所有已建立的连接。
  • Swoole\Server::getLastError — 获取最近一次错误的错误代码。
  • Swoole\Server::heartbeat — 检查服务器上所有连接。
  • Swoole\Server::listen — 监听给定的 IP 和端口，套接字类型。
  • Swoole\Server::on — 通过事件名称注册回调函数。
  • Swoole\Server::pause — 停止接收来自连接的数据。
  • Swoole\Server::protect — 将连接设置为保护模式。
  • Swoole\Server::reload — 重启所有工作进程。
  • Swoole\Server::resume — 开始接收来自连接的数据。
  • Swoole\Server::send — 向客户端发送数据。
  • Swoole\Server::sendfile — 向连接发送文件。
  • Swoole\Server::sendMessage — 通过 ID 向工作进程发送消息。
  • Swoole\Server::sendto — 向远程 UDP 地址发送数据。
  • Swoole\Server::sendwait — 以阻塞方式向远程套接字发送数据。
  • Swoole\Server::set — 设置 Swoole 服务器的运行时设置。
  • Swoole\Server::shutdown — 关闭主服务器进程，此函数可以在工作进程中调用。
  • Swoole\Server::start — 启动 Swoole 服务器。
  • Swoole\Server::stats — 获取 Swoole 服务器的统计信息。
  • Swoole\Server::stop — 停止 Swoole 服务器。
  • Swoole\Server::task — 向任务工作进程发送数据。
  • Swoole\Server::taskwait — 以阻塞方式向任务工作进程发送数据。
  • Swoole\Server::taskWaitMulti — 并发执行多个任务。
  • Swoole\Server::tick — 以给定的时间间隔重复执行给定的函数。
• Swoole\Table — Swoole\Table 类
  • Swoole\Table::column — 设置列的数据类型和大小。
  • Swoole\Table::__construct — 构造一个固定大小的 Swoole 内存表。
  • Swoole\Table::count — 计数表中的行数，如果 $mode = 1，则计数表中的所有元素。
  • Swoole\Table::create — 创建 Swoole 内存表。
  • Swoole\Table::current — 获取当前行。
  • Swoole\Table::decr — 通过 $row_key 和 $column_key 递减 Swoole 表中的值。
  • Swoole\Table::del — 通过 $row_key 删除 Swoole 表中的一行。
  • Swoole\Table::destroy — 销毁 Swoole 表。
  • Swoole\Table::exist — 检查通过 $row_key 是否存在一行。
  • Swoole\Table::get — 通过 $row_key 和 $column_key 获取 Swoole 表中的值。
  • Swoole\Table::incr — 通过 $row_key 和 $column_key 递增值。
  • Swoole\Table::key — 获取当前行的键。
  • Swoole\Table::next — 迭代下一行。
  • Swoole\Table::rewind — 倒回迭代器。
  • Swoole\Table::set — 通过 $row_key 更新表的一行。
  • Swoole\Table::valid — 检查当前行是否有效。
• Swoole\Timer — Swoole\Timer 类
  • Swoole\Timer::after — 一段时间后触发回调函数。
  • Swoole\Timer::clear — 通过计时器 ID 删除计时器。
  • Swoole\Timer::exists — 检查计时器是否存在。
  • Swoole\Timer::tick — 以给定的时间间隔重复执行给定的函数。
• Swoole\WebSocket\Frame — Swoole\WebSocket\Frame 类
• Swoole\WebSocket\Server — Swoole\WebSocket\Server 类
  • Swoole\WebSocket\Server::exist — 检查文件描述符是否存在。
  • Swoole\WebSocket\Server::on — 注册事件回调函数
  • Swoole\WebSocket\Server::pack — 获取要在单个帧中发送的二进制数据包。
  • Swoole\WebSocket\Server::push — 将数据推送到远程客户端。
  • Swoole\WebSocket\Server::unpack — 解包从客户端接收到的二进制数据。