Alguns Exemplos

Exemplo Um

Definição do Protocolo

• Um cabeçalho fixo de 10 bytes para armazenar o comprimento total do pacote, preenchido com 0 se o número de dígitos for insuficiente
• O formato de dados é xml

Amostra do Pacote de Dados

0000000121<?xml version="1.0" encoding="ISO-8859-1"?>
<request>
    <module>user</module>
    <action>getInfo</action>
</request>

Onde 0000000121 representa o comprimento total do pacote, seguido imediatamente pelo corpo do pacote no formato xml.

Implementação do Protocolo

namespace Protocols;
class XmlProtocol
{
    public static function input($recv_buffer)
    {
        if(strlen($recv_buffer) < 10)
        {
            // Se não houverem 10 bytes, retorna 0 e continua aguardando os dados
            return 0;
        }
        // Retorna o comprimento do pacote, que inclui o comprimento do cabeçalho + comprimento do corpo
        $total_len = base_convert(substr($recv_buffer, 0, 10), 10, 10);
        return $total_len;
    }

    public static function decode($recv_buffer)
    {
        // Corpo do pacote de solicitação
        $body = substr($recv_buffer, 10);
        return simplexml_load_string($body);
    }

    public static function encode($xml_string)
    {
        // Comprimento do corpo + comprimento do cabeçalho
        $total_length = strlen($xml_string)+10;
        // Preencher a parte do comprimento para ter 10 bytes, preenchendo com 0 se necessário
        $total_length_str = str_pad($total_length, 10, '0', STR_PAD_LEFT);
        // Retorna os dados
        return $total_length_str . $xml_string;
    }
}

Exemplo Dois

Definição do Protocolo

• Um cabeçalho de 4 bytes em rede em formato unsigned int, que indica o comprimento total do pacote
• A parte de dados é uma string Json

Amostra do Pacote de Dados

****{"type":"message","content":"hello all"}

Onde os quatro primeiros bytes marcados com * representam um dado unsigned int em formato de rede, um caractere invisível, seguido pelos dados do corpo em formato Json.

Implementação do Protocolo

namespace Protocols;
class JsonInt
{
    public static function input($recv_buffer)
    {
        // Se os dados recebidos ainda não tiverem 4 bytes, não é possível determinar o comprimento do pacote, retorna 0 e continua aguardando dados
        if(strlen($recv_buffer)<4)
        {
            return 0;
        }
        // Usa a função unpack para converter os 4 bytes do cabeçalho em número, onde os 4 bytes correspondem ao comprimento total do pacote
        $unpack_data = unpack('Ntotal_length', $recv_buffer);
        return $unpack_data['total_length'];
    }

    public static function decode($recv_buffer)
    {
        // Remove os 4 bytes do cabeçalho, obtendo os dados Json do corpo
        $body_json_str = substr($recv_buffer, 4);
        // Decodifica o json
        return json_decode($body_json_str, true);
    }

    public static function encode($data)
    {
        // Codifica em Json para obter o corpo
        $body_json_str = json_encode($data);
        // Calcula o comprimento total do pacote, 4 bytes do cabeçalho + bytes do corpo
        $total_length = 4 + strlen($body_json_str);
        // Retorna os dados empacotados
        return pack('N',$total_length) . $body_json_str;
    }
}

Exemplo Três (Usando Protocolo Binário para Enviar Arquivos)

Definição do Protocolo

struct
{
  unsigned int total_len;  // Comprimento total do pacote, em formato de rede big-endian
  char         name_len;   // Comprimento do nome do arquivo
  char         name[name_len]; // Nome do arquivo
  char         file[total_len - BinaryTransfer::PACKAGE_HEAD_LEN - name_len]; // Dados do arquivo
}

Amostra do Protocolo

 *****logo.png****************** 

Onde os quatro primeiros bytes marcados com representam um dado unsigned int em formato de rede, um caractere invisível, o quinto é um byte que armazena o comprimento do nome do arquivo, seguido pelo nome do arquivo e, em seguida, os dados do arquivo binário original.

Implementação do Protocolo

namespace Protocols;
class BinaryTransfer
{
    // Comprimento do cabeçalho do protocolo
    const PACKAGE_HEAD_LEN = 5;

    public static function input($recv_buffer)
    {
        // Se não houver comprimento suficiente para o cabeçalho do protocolo, continue aguardando
        if(strlen($recv_buffer) < self::PACKAGE_HEAD_LEN)
        {
            return 0;
        }
        // Desempacotar
        $package_data = unpack('Ntotal_len/Cname_len', $recv_buffer);
        // Retorna o comprimento do pacote
        return $package_data['total_len'];
    }

    public static function decode($recv_buffer)
    {
        // Desempacotar
        $package_data = unpack('Ntotal_len/Cname_len', $recv_buffer);
        // Comprimento do nome do arquivo
        $name_len = $package_data['name_len'];
        // Extrai o nome do arquivo do fluxo de dados
        $file_name = substr($recv_buffer, self::PACKAGE_HEAD_LEN, $name_len);
        // Extrai os dados binários do arquivo do fluxo de dados
        $file_data = substr($recv_buffer, self::PACKAGE_HEAD_LEN + $name_len);
         return array(
             'file_name' => $file_name,
             'file_data' => $file_data,
         );
    }

    public static function encode($data)
    {
        // Pode codificar os dados que serão enviados ao cliente de acordo com sua necessidade, aqui apenas retornamos o texto original
        return $data;
    }
}

Exemplo de Uso do Protocolo no Servidor

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('BinaryTransfer://0.0.0.0:8333');
// Salva o arquivo em tmp
$worker->onMessage = function(TcpConnection $connection, $data)
{
    $save_path = '/tmp/'.$data['file_name'];
    file_put_contents($save_path, $data['file_data']);
    $connection->send("upload success. save path $save_path");
};

Worker::runAll();

Arquivo do Cliente client.php (Aqui usamos php para simular o upload do cliente)

<?php
/** Cliente de upload de arquivos **/
// Endereço de upload
$address = "127.0.0.1:8333";
// Verifica o parâmetro de caminho do arquivo a ser enviado
if(!isset($argv[1]))
{
   exit("use php client.php \$file_path\n");
}
// Caminho do arquivo a ser enviado
$file_to_transfer = trim($argv[1]);
// O arquivo a ser enviado não existe localmente
if(!is_file($file_to_transfer))
{
    exit("$file_to_transfer not exist\n");
}
// Estabelece a conexão socket
$client = stream_socket_client($address, $errno, $errmsg);
if(!$client)
{
    exit("$errmsg\n");
}
// Configura como bloqueante
stream_set_blocking($client, 1);
// Nome do arquivo
$file_name = basename($file_to_transfer);
// Dados binários do arquivo
$file_data = file_get_contents($file_to_transfer);
// Comprimento do cabeçalho do protocolo 4 bytes do comprimento + 1 byte do comprimento do nome do arquivo
$PACKAGE_HEAD_LEN = 5;
// Pacote do protocolo
$package = pack('NC', $PACKAGE_HEAD_LEN  + strlen($file_name) + strlen($file_data), $name_len) . $file_name . $file_data;
// Executa o upload
fwrite($client, $package);
// Imprime o resultado
echo fread($client, 8192),"\n";

Exemplo de Uso do Cliente

Execute no terminal php client.php <file_path>

Por exemplo php client.php abc.jpg

Exemplo Quatro (Usando Protocolo de Texto para Enviar Arquivos)

Definição do Protocolo

json + nova linha, onde o json contém o nome do arquivo e os dados do arquivo codificados em base64 (aumentará o tamanho em 1/3).

Amostra do Protocolo

{"file_name":"logo.png","file_data":"PD9waHAKLyo......"}\n

Observe que o final é um caractere de nova linha, que no PHP é indicado pelo caractere de aspas duplas "\n".

Implementação do Protocolo

namespace Protocols;
class TextTransfer
{
    public static function input($recv_buffer)
    {
        $recv_len = strlen($recv_buffer);
        if($recv_buffer[$recv_len-1] !== "\n")
        {
            return 0;
        }
        return strlen($recv_buffer);
    }

    public static function decode($recv_buffer)
    {
        // Desempacotar
        $package_data = json_decode(trim($recv_buffer), true);
        // Extrai o nome do arquivo
        $file_name = $package_data['file_name'];
        // Extrai os dados do arquivo codificados em base64
        $file_data = $package_data['file_data'];
        // Restaura os dados binários do arquivo a partir do base64_decode
        $file_data = base64_decode($file_data);
        // Retorna os dados
        return array(
             'file_name' => $file_name,
             'file_data' => $file_data,
         );
    }

    public static function encode($data)
    {
        // Pode codificar os dados que serão enviados ao cliente de acordo com sua necessidade, aqui apenas retornamos o texto original
        return $data;
    }
}

Exemplo de Uso do Protocolo no Servidor

Nota: A escrita é semelhante à do upload binário, ou seja, é possível alternar entre os protocolos sem mudar praticamente nenhum código de negócio.

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('TextTransfer://0.0.0.0:8333');
// Salva o arquivo em tmp
$worker->onMessage = function(TcpConnection $connection, $data)
{
    $save_path = '/tmp/'.$data['file_name'];
    file_put_contents($save_path, $data['file_data']);
    $connection->send("upload success. save path $save_path");
};

Worker::runAll();

Arquivo do Cliente textclient.php (Aqui usamos php para simular o upload do cliente)

<?php
/** Cliente de upload de arquivos **/
// Endereço de upload
$address = "127.0.0.1:8333";
// Verifica o parâmetro de caminho do arquivo a ser enviado
if(!isset($argv[1]))
{
   exit("use php client.php \$file_path\n");
}
// Caminho do arquivo a ser enviado
$file_to_transfer = trim($argv[1]);
// O arquivo a ser enviado não existe localmente
if(!is_file($file_to_transfer))
{
    exit("$file_to_transfer not exist\n");
}
// Estabelece a conexão socket
$client = stream_socket_client($address, $errno, $errmsg);
if(!$client)
{
    exit("$errmsg\n");
}
stream_set_blocking($client, 1);
// Nome do arquivo
$file_name = basename($file_to_transfer);
// Dados binários do arquivo
$file_data = file_get_contents($file_to_transfer);
// Codificação em base64
$file_data = base64_encode($file_data);
// Dados do pacote
$package_data = array(
    'file_name' => $file_name,
    'file_data' => $file_data,
);
// Pacote do protocolo json + nova linha
$package = json_encode($package_data)."\n";
// Executa o upload
fwrite($client, $package);
// Imprime o resultado
echo fread($client, 8192),"\n";

Exemplo de Uso do Cliente

Execute no terminal php textclient.php <file_path>

Por exemplo php textclient.php abc.jpg