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 — 將通訊端的新回呼函式新增到事件迴圈中
  • swoole_event_defer — 將回呼函式新增至下一個事件迴圈
  • swoole_event_del — 移除一個 socket 的所有事件回呼函式
  • swoole_event_exit — 退出事件迴圈，僅在客戶端可用
  • swoole_event_set — 更新一個 socket 的事件回呼函式
  • swoole_event_wait — 啟動事件迴圈
  • swoole_event_write — 將資料寫入 socket
  • 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 通道
  • Swoole\Channel::__destruct — 解構 Swoole 通道。
  • Swoole\Channel::pop — 從 Swoole 通道讀取並彈出數據。
  • Swoole\Channel::push — 將數據寫入並推送到 Swoole 通道。
  • Swoole\Channel::stats — 取得 Swoole 通道的統計資訊。
• 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 — 將連線指派給指定的偏移量。
  • 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 — 發送 GET 請求
  • Swoole\Coroutine\Http\Client::getDefer — 取得延遲標記
  • Swoole\Coroutine\Http\Client::isConnected — 檢查是否已連線
  • Swoole\Coroutine\Http\Client::post — 發送 POST 請求
  • Swoole\Coroutine\Http\Client::recv — 接收回應
  • Swoole\Coroutine\Http\Client::set — 設定選項
  • Swoole\Coroutine\Http\Client::setCookies — 設定 Cookies
  • 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 — 取得協程 ID
  • Swoole\Coroutine::resume — 恢復協程
  • Swoole\Coroutine::suspend — 掛起協程
• Swoole\Event — Swoole\Event 類別
  • Swoole\Event::add — 將socket的新回調函數添加到EventLoop中。
  • Swoole\Event::defer — 將回調函數添加到下一個事件迴圈中。
  • Swoole\Event::del — 移除一個 Socket 的所有事件回呼函式。
  • Swoole\Event::exit — 退出事件循環，僅在客戶端可用。
  • Swoole\Event::set — 更新一個 Socket 的事件回呼函式。
  • Swoole\Event::wait — 描述
  • Swoole\Event::write — 將資料寫入 Socket。
• Swoole\Exception — Swoole\Exception 類別
• Swoole\Http\Client — Swoole\Http\Client 類別
  • Swoole\Http\Client::addFile — 新增檔案到表單提交資料中。
  • 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 請求的 Cookies。
  • Swoole\Http\Client::setData — 設定 HTTP 請求的 Body 資料。
  • Swoole\Http\Client::setHeaders — 設定 HTTP 請求的 Headers。
  • 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 Body。
• Swoole\Http\Response — Swoole\Http\Response 類別
  • Swoole\Http\Response::cookie — 設定 HTTP 回應的 Cookies。
  • Swoole\Http\Response::__destruct — 解構 HTTP 回應。
  • Swoole\Http\Response::end — 發送 HTTP 請求的資料並結束回應。
  • Swoole\Http\Response::gzip — 啟用回應內容的 gzip 壓縮。
  • Swoole\Http\Response::header — 設定 HTTP 回應的 Headers。
  • Swoole\Http\Response::initHeader — 初始化 HTTP 回應 Header。
  • Swoole\Http\Response::rawcookie — 設定原始 Cookies 到 HTTP 回應。
  • Swoole\Http\Response::sendfile — 透過 HTTP 回應發送檔案。
  • Swoole\Http\Response::status — 設定 HTTP 回應的狀態碼。
  • Swoole\Http\Response::write — 將 HTTP Body 內容附加到 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 — 發送資料到工作行程 (Task Worker)。
  • 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 — 將 Swoole 表格中指定鍵值 ($row_key 和 $column_key) 的值遞減。
  • 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 — 解封從客戶端接收的二進位資料。