hyperf/docs/en/rpc-multiplex.md

Multiplexed based RPC components

This component is based on the TCP protocol, and the multiplexing design is borrowed from the AMQP component.

Install

composer require hyperf/rpc-multiplex

Server configuration

Modify the config/autoload/server.php configuration file, the following configuration deletes irrelevant configuration.

In the settings setting, the subcontracting rules are not allowed to be modified, only package_max_length can be modified, this configuration needs to be consistent between Server and Client.

<?php

declare(strict_types=1);

use Hyperf\Server\Event;
use Hyperf\Server\Server;

return [
    'servers' => [
        [
            'name' => 'rpc',
            'type' => Server::SERVER_BASE,
            'host' => '0.0.0.0',
            'port' => 9502,
            'sock_type' => SWOOLE_SOCK_TCP,
            'callbacks' => [
                Event::ON_RECEIVE => [Hyperf\RpcMultiplex\TcpServer::class, 'onReceive'],
            ],
            'settings' => [
                'open_length_check' => true,
                'package_length_type' => 'N',
                'package_length_offset' => 0,
                'package_body_offset' => 4,
                'package_max_length' => 1024 * 1024 * 2,
            ],
        ],
    ],
];

Create RpcService

<?php

namespace App\RPC;

use App\JsonRpc\CalculatorServiceInterface;
use Hyperf\RpcMultiplex\Constant;
use Hyperf\RpcServer\Annotation\RpcService;

/**
 * @RpcService(name="CalculatorService", server="rpc", protocol=Constant::PROTOCOL_DEFAULT)
 */
class CalculatorService implements CalculatorServiceInterface
{
}

client configuration

Modify the config/autoload/services.php configuration file

<?php

declare(strict_types=1);

return [
    'consumers' => [
        [
            'name' => 'CalculatorService',
            'service' => App\JsonRpc\CalculatorServiceInterface::class,
            'id' => App\JsonRpc\CalculatorServiceInterface::class,
            'protocol' => Hyperf\RpcMultiplex\Constant::PROTOCOL_DEFAULT,
            'load_balancer' => 'random',
            // Which service center does the consumer want to obtain node information from, if not configured, the node information will not be obtained from the service center
            'registry' => [
                'protocol' => 'consul',
                'address' => 'http://127.0.0.1:8500',
            ],
            'nodes' => [
                ['host' => '127.0.0.1', 'port' => 9502],
            ],
            'options' => [
                'connect_timeout' => 5.0,
                'recv_timeout' => 5.0,
                'settings' => [
                    // The maximum value of the package body. If it is less than the data size returned by the Server, an exception will be thrown, so try to control the package body size as much as possible.
                    'package_max_length' => 1024 * 1024 * 2,
                ],
                // number of retries, default is 2
                'retry_count' => 2,
                // retry interval, milliseconds
                'retry_interval' => 100,
                // Number of multiplexed clients
                'client_count' => 4,
                // Heartbeat interval non-numeric means no heartbeat
                'heartbeat' => 30,
            ],
        ],
    ],
];

Registration Center

If you need to use the registry, you need to manually add the following listeners

<?php
return [
    Hyperf\RpcMultiplex\Listener\RegisterServiceListener::class,
];