mirror of
https://gitee.com/hyperf/hyperf.git
synced 2024-12-05 05:07:58 +08:00
52094d0fad
- Added demo for query builder. - Added meilisearch client into awesome components. Co-authored-by: codelin <494020937@qq.com> Co-authored-by: Alone88 <im@alone88.cn> Co-authored-by: 李铭昕 <715557344@qq.com>
1.8 KiB
1.8 KiB
WebSocket coroutine client
Hyperf provides an encapsulation of WebSocket Client. The WebSocket Server could be accessed through hyperf/websocket-client component.
Installation
composer require hyperf/websocket-client
Usage
Hyperf\WebSocketClient\ClientFactory
is provided to create Hyperf\WebSocketClient\Client
objects.
<?php
declare(strict_types=1);
namespace App\Controller;
use Hyperf\Di\Annotation\Inject;
use Hyperf\WebSocketClient\ClientFactory;
use Hyperf\WebSocketClient\Frame;
class IndexController
{
#[Inject]
protected ClientFactory $clientFactory;
public function index()
{
// The address of the peer service. If there is no prefix like ws:// or wss://, then the ws:// would be used as default.
$host = '127.0.0.1:9502';
// Create Client object through ClientFactory. Short-lived objects will be created.
$client = $this->clientFactory->create($host);
// Send a message to the WebSocket server
$client->push('Use WebSocket Client to send data in HttpServer.');
// Get a response from the server. The server should use 'push()' to send messages to fd of the client, only in this way, can the response be received.
// A Frame object is taken as an example in following with 2 seconds timeout.
/** @var Frame $msg */
$msg = $client->recv(2);
// Get text data: $res_msg->data
return $msg->data;
}
}
Close the $autoClose
By default, the created Client
object will be closed by defer
. If it is not wished, the auto-close could be closed by setting the $autoClose
as false
when a Client
is in instantiating.
$autoClose = false;
$client = $clientFactory->create($host, $autoClose);