Bazı Örnekler

Örnek Bir

Protokol Tanımı

• Başlık, tüm veri paketi uzunluğunu saklamak için 10 byte sabit uzunluğundadır, bit sayısı yetersizse 0 ile tamamlanır
• Veri formatı xml'dir

Veri Paketi Örneği

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

Burada 0000000121, tüm veri paketi uzunluğunu temsil eder; ardından xml veri formatının paket gövde içeriği gelir.

Protokol Uygulaması

namespace Protocols;
class XmlProtocol
{
    public static function input($recv_buffer)
    {
        if(strlen($recv_buffer) < 10)
        {
            // 10 byte'tan az, 0 döndür ve veriyi beklemeye devam et
            return 0;
        }
        // Paket uzunluğunu döndür, paket uzunluğu başlık veri uzunluğu + paket gövde uzunluğu içerir
        $total_len = base_convert(substr($recv_buffer, 0, 10), 10, 10);
        return $total_len;
    }

    public static function decode($recv_buffer)
    {
        // İstek paket gövdesi
        $body = substr($recv_buffer, 10);
        return simplexml_load_string($body);
    }

    public static function encode($xml_string)
    {
        // Paket gövdesi + başlık uzunluğu
        $total_length = strlen($xml_string)+10;
        // Uzunluk kısmı 10 byte olacak şekilde tamamlanır, bit sayısı yetersizse 0 ile tamamlanır
        $total_length_str = str_pad($total_length, 10, '0', STR_PAD_LEFT);
        // Veriyi döndür
        return $total_length_str . $xml_string;
    }
}

Örnek İki

Protokol Tanımı

• Başlık, 4 byte ağ bayt sırasına göre unsigned int, tüm paketin uzunluğunu işaret eder
• Veri kısmı Json stringidir

Veri Paketi Örneği

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

Burada baştaki dört yıldız * simgesi, görünmez karakter olarak bir ağ bayt sırasının unsigned int verisini temsil eder; ardından Json veri formatındaki paket gövde verisi gelir.

Protokol Uygulaması

namespace Protocols;
class JsonInt
{
    public static function input($recv_buffer)
    {
        // Alınan veriler 4 byte'tan az ise, paket uzunluğunu bilemeyeceğimiz için 0 döndür ve veriyi beklemeye devam et
        if(strlen($recv_buffer)<4)
        {
            return 0;
        }
        // unpack fonksiyonunu kullanarak başlıktaki 4 byte'ı sayıya çevir, başlık 4 byte aslında tüm veri paketinin uzunluğudur
        $unpack_data = unpack('Ntotal_length', $recv_buffer);
        return $unpack_data['total_length'];
    }

    public static function decode($recv_buffer)
    {
        // Başlıktaki 4 byte'ı kaldırın, paket gövdesi Json verisini elde edin
        $body_json_str = substr($recv_buffer, 4);
        // json çözümlemesi
        return json_decode($body_json_str, true);
    }

    public static function encode($data)
    {
        // Json kodlaması ile paket gövdesini alın
        $body_json_str = json_encode($data);
        // Tüm paketin uzunluğunu hesaplayın, başlık 4 byte + paket gövde byte sayısı
        $total_length = 4 + strlen($body_json_str);
        // Paketlenmiş veriyi döndür
        return pack('N',$total_length) . $body_json_str;
    }
}

Örnek Üç (İkili protokol ile dosya yükleme)

Protokol Tanımı

struct
{
  unsigned int total_len;  // Tüm paketin uzunluğu, büyük endian ağ bayt sırası
  char         name_len;   // Dosya adının uzunluğu
  char         name[name_len]; // Dosya adı
  char         file[total_len - BinaryTransfer::PACKAGE_HEAD_LEN - name_len]; // Dosya verisi
}

Protokol Örneği

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

Burada baştaki dört yıldız simgesi, görünmez karakter olarak bir ağ bayt sırasının unsigned int verisini temsil eder; 5. ise dosya adı uzunluğunu saklamak için bir byte kullanır; hemen ardından dosya adı gelir, ardından orijinal ikili dosya verisi gelir.

Protokol Uygulaması

namespace Protocols;
class BinaryTransfer
{
    // Protokol başlık uzunluğu
    const PACKAGE_HEAD_LEN = 5;

    public static function input($recv_buffer)
    {
        // Eğer bir protokol başlığının uzunluğundan az ise, beklemeye devam et
        if(strlen($recv_buffer) < self::PACKAGE_HEAD_LEN)
        {
            return 0;
        }
        // Paketleri aç
        $package_data = unpack('Ntotal_len/Cname_len', $recv_buffer);
        // Paket uzunluğunu döndür
        return $package_data['total_len'];
    }

    public static function decode($recv_buffer)
    {
        // Paket aç
        $package_data = unpack('Ntotal_len/Cname_len', $recv_buffer);
        // Dosya adı uzunluğu
        $name_len = $package_data['name_len'];
        // Veri akışından dosya adını çıkartın
        $file_name = substr($recv_buffer, self::PACKAGE_HEAD_LEN, $name_len);
        // Veri akışından dosya ikili verisini çıkartın
        $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)
    {
        // İhtiyaçlarınıza göre istemciye gönderilecek verilerin kodlamasını yapabilirsiniz, burada yalnızca metin olarak geri döndürülmektedir.
        return $data;
    }
}

Sunucu Protokol Kullanım Örneği

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

$worker = new Worker('BinaryTransfer://0.0.0.0:8333');
// Dosyayı tmp dizinine kaydet
$worker->onMessage = function(TcpConnection $connection, $data)
{
    $save_path = '/tmp/'.$data['file_name'];
    file_put_contents($save_path, $data['file_data']);
    $connection->send("yükleme başarılı. kaydetme yolu $save_path");
};

Worker::runAll();

İstemci Dosyası client.php (Burada php ile istemcinin yüklemesini simüle ediyoruz)

<?php
/** Dosya yükleme istemcisi **/
// Yükleme adresi
$address = "127.0.0.1:8333";
// Yükleme dosyası yolu parametresini kontrol et
if(!isset($argv[1]))
{
   exit("php client.php \$file_path kullanın\n");
}
// Yükleme dosyası yolu
$file_to_transfer = trim($argv[1]);
// Yüklenen dosya yerel olarak mevcut değil
if(!is_file($file_to_transfer))
{
    exit("$file_to_transfer mevcut değil\n");
}
// socket bağlantısını kur
$client = stream_socket_client($address, $errno, $errmsg);
if(!$client)
{
    exit("$errmsg\n");
}
// Engelleyici olarak ayarla
stream_set_blocking($client, 1);
// Dosya adı
$file_name = basename($file_to_transfer);
// Dosya adı uzunluğu
$name_len = strlen($file_name);
// Dosya ikili verisi
$file_data = file_get_contents($file_to_transfer);
// Protokol başlık uzunluğu 4 byte paket uzunluğu + 1 byte dosya adı uzunluğu
$PACKAGE_HEAD_LEN = 5;
// Protokol paketi
$package = pack('NC', $PACKAGE_HEAD_LEN  + strlen($file_name) + strlen($file_data), $name_len) . $file_name . $file_data;
// Yüklemeyi gerçekleştir
fwrite($client, $package);
// Sonucu yazdır
echo fread($client, 8192),"\n";

İstemci Kullanım Örneği

Komut satırında php client.php <dosya yolu> olarak çalıştırın.

Örneğin php client.php abc.jpg

Örnek Dört (Metin protokolü ile dosya yükleme)

Protokol Tanımı

json + yeni satır, json içinde dosya adı ve base64_encode ile kodlanmış (1/3 oranında büyütecek) dosya verisini içerir.

Protokol Örneği

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

Dikkat, sonunda bir yeni satır karakteri vardır; PHP'de çift tırnak karakteri ile "\n" olarak gösterilir.

Protokol Uygulaması

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)
    {
        // Paketi aç
        $package_data = json_decode(trim($recv_buffer), true);
        // Dosya adını alın
        $file_name = $package_data['file_name'];
        // base64_encode edilen dosya verisini alın
        $file_data = $package_data['file_data'];
        // base64_decode ile orijinal ikili dosya verisini geri yükleyin
        $file_data = base64_decode($file_data);
        // Veriyi döndür
        return array(
             'file_name' => $file_name,
             'file_data' => $file_data,
         );
    }

    public static function encode($data)
    {
        // İhtiyaçlarınıza göre istemciye gönderilecek verilerin kodlamasını yapabilirsiniz; burada yalnızca metin olarak geri döndürülmektedir.
        return $data;
    }
}

Sunucu Protokol Kullanım Örneği

Açıklama: Yazım şekli, ikili yükleme yazım şekli ile aynıdır, yani neredeyse hiçbir iş kodunu değiştirmeden protokolü değiştirebilirsiniz.

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

$worker = new Worker('TextTransfer://0.0.0.0:8333');
// Dosyayı tmp dizinine kaydet
$worker->onMessage = function(TcpConnection $connection, $data)
{
    $save_path = '/tmp/'.$data['file_name'];
    file_put_contents($save_path, $data['file_data']);
    $connection->send("yükleme başarılı. kaydetme yolu $save_path");
};

Worker::runAll();

İstemci Dosyası textclient.php (Burada php ile istemcinin yüklemesini simüle ediyoruz)

<?php
/** Dosya yükleme istemcisi **/
// Yükleme adresi
$address = "127.0.0.1:8333";
// Yükleme dosyası yolu parametresini kontrol et
if(!isset($argv[1]))
{
   exit("php textclient.php \$file_path kullanın\n");
}
// Yükleme dosyası yolu
$file_to_transfer = trim($argv[1]);
// Yüklenen dosya yerel olarak mevcut değil
if(!is_file($file_to_transfer))
{
    exit("$file_to_transfer mevcut değil\n");
}
// socket bağlantısını kur
$client = stream_socket_client($address, $errno, $errmsg);
if(!$client)
{
    exit("$errmsg\n");
}
stream_set_blocking($client, 1);
// Dosya adı
$file_name = basename($file_to_transfer);
// Dosya ikili verisi
$file_data = file_get_contents($file_to_transfer);
// base64 kodlama
$file_data = base64_encode($file_data);
// Veri paketi
$package_data = array(
    'file_name' => $file_name,
    'file_data' => $file_data,
);
// Protokol paketi json + yeni satır
$package = json_encode($package_data)."\n";
// Yüklemeyi gerçekleştir
fwrite($client, $package);
// Sonucu yazdır
echo fread($client, 8192),"\n";

İstemci Kullanım Örneği

Komut satırında php textclient.php <dosya yolu> olarak çalıştırın.

Örneğin php textclient.php abc.jpg