いくつかの例
例1
プロトコル定義
- ヘッダは固定10バイトの長さで、パッケージ全体の長さを保存し、ビット数が足りない場合は0で埋める
- データ形式はxml
データパッケージサンプル
0000000121<?xml version="1.0" encoding="ISO-8859-1"?>
<request>
<module>user</module>
<action>getInfo</action>
</request>ここで0000000121はパッケージ全体の長さを表し、次にxmlデータ形式のボディ内容が続きます。
プロトコル実装
namespace Protocols;
class XmlProtocol
{
public static function input($recv_buffer)
{
if(strlen($recv_buffer) < 10)
{
// 10バイトに満たないため、0を返してデータの受信を待ち続ける
return 0;
}
// パッケージ長を返す、パッケージ長はヘッダデータの長さ+ボディの長さを含む
$total_len = base_convert(substr($recv_buffer, 0, 10), 10, 10);
return $total_len;
}
public static function decode($recv_buffer)
{
// リクエストボディ
$body = substr($recv_buffer, 10);
return simplexml_load_string($body);
}
public static function encode($xml_string)
{
// ボディ+ヘッダの長さ
$total_length = strlen($xml_string)+10;
// 長さ部分を10バイトに満たすように、ビット数が足りない場合は0で埋める
$total_length_str = str_pad($total_length, 10, '0', STR_PAD_LEFT);
// データを返す
return $total_length_str . $xml_string;
}
}例2
プロトコル定義
- ヘッダは4バイトのネットワークバイトオーダーのunsigned intで、パッケージ全体の長さを示す
- データ部分はJson文字列
データパッケージサンプル
****{"type":"message","content":"hello all"}
ここでヘッダの4バイトは*で表されるネットワークバイトオーダーのunsigned intデータで、不可視文字です。続いてJsonデータ形式のボディデータがあります。
プロトコル実装
namespace Protocols;
class JsonInt
{
public static function input($recv_buffer)
{
// 受信したデータが4バイトに満たないため、パッケージの長さがわからず、0を返してデータの受信を待ち続ける
if(strlen($recv_buffer)<4)
{
return 0;
}
// unpack関数を利用してヘッダの4バイトを数字に変換し、ヘッダの4バイトがパッケージ全体の長さとなる
$unpack_data = unpack('Ntotal_length', $recv_buffer);
return $unpack_data['total_length'];
}
public static function decode($recv_buffer)
{
// ヘッダ4バイトを除去し、ボディJsonデータを取得する
$body_json_str = substr($recv_buffer, 4);
// jsonデコード
return json_decode($body_json_str, true);
}
public static function encode($data)
{
// Jsonエンコードしてボディを取得する
$body_json_str = json_encode($data);
// パッケージ全体の長さを計算する、ヘッダの4バイト+ボディのバイト数
$total_length = 4 + strlen($body_json_str);
// パッケージされたデータを返す
return pack('N',$total_length) . $body_json_str;
}
}例3（バイナリプロトコルを使用してファイルをアップロード）
プロトコル定義
struct
{
unsigned int total_len; // パッケージ全体の長さ、大端ネットワークバイトオーダー
char name_len; // ファイル名の長さ
char name[name_len]; // ファイル名
char file[total_len - BinaryTransfer::PACKAGE_HEAD_LEN - name_len]; // ファイルデータ
}プロトコルサンプル
*****logo.png******************
ここでヘッダの4バイトのはネットワークバイトオーダーのunsigned intデータで、不可視文字です。第5のは1バイトでファイル名の長さを保存し、その後にファイル名が続き、続いて元のバイナリファイルデータがあります。
プロトコル実装
namespace Protocols;
class BinaryTransfer
{
// プロトコルヘッダの長さ
const PACKAGE_HEAD_LEN = 5;
public static function input($recv_buffer)
{
// プロトコルヘッダの長さに満たない場合は待機を続ける
if(strlen($recv_buffer) < self::PACKAGE_HEAD_LEN)
{
return 0;
}
// データをアンパック
$package_data = unpack('Ntotal_len/Cname_len', $recv_buffer);
// パッケージ長を返す
return $package_data['total_len'];
}
public static function decode($recv_buffer)
{
// アンパック
$package_data = unpack('Ntotal_len/Cname_len', $recv_buffer);
// ファイル名の長さ
$name_len = $package_data['name_len'];
// データストリームからファイル名を切り取る
$file_name = substr($recv_buffer, self::PACKAGE_HEAD_LEN, $name_len);
// データストリームからファイルのバイナリデータを切り取る
$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)
{
// 必要に応じてクライアントに送信するデータをエンコードすることができます。本例ではテキストをそのまま返します。
return $data;
}
}サーバプロトコル使用例
use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';
$worker = new Worker('BinaryTransfer://0.0.0.0:8333');
// ファイルを/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();クライアントファイル client.php （ここではphpを使用してクライアントのアップロードをシミュレート）
<?php
/** ファイルをアップロードするクライアント **/
// アップロード先
$address = "127.0.0.1:8333";
// アップロードファイルパスパラメータを確認
if(!isset($argv[1]))
{
exit("use php client.php \$file_path\n");
}
// アップロードするファイルパス
$file_to_transfer = trim($argv[1]);
// アップロードされるファイルがローカルに存在しない
if(!is_file($file_to_transfer))
{
exit("$file_to_transfer not exist\n");
}
// ソケット接続を作成
$client = stream_socket_client($address, $errno, $errmsg);
if(!$client)
{
exit("$errmsg\n");
}
// ブロッキングモードに設定
stream_set_blocking($client, 1);
// ファイル名
$file_name = basename($file_to_transfer);
// ファイル名の長さ
$name_len = strlen($file_name);
// ファイルのバイナリデータ
$file_data = file_get_contents($file_to_transfer);
// プロトコルヘッダの長さ 4バイトパッケージ長+1バイトファイル名の長さ
$PACKAGE_HEAD_LEN = 5;
// プロトコルパッケージ
$package = pack('NC', $PACKAGE_HEAD_LEN + strlen($file_name) + strlen($file_data), $name_len) . $file_name . $file_data;
// アップロードを実行
fwrite($client, $package);
// 結果を出力
echo fread($client, 8192),"\n";クライアント使用例
コマンドラインで php client.php <ファイルパス> を実行
例えば php client.php abc.jpg
例4（テキストプロトコルを使用してファイルをアップロード）
プロトコル定義
json+改行、json中にはファイル名とbase64_encodeされた（体積が1/3増加する）ファイルデータが含まれます。
プロトコルサンプル
{"file_name":"logo.png","file_data":"PD9waHAKLyo......"}\n
注意：末尾に改行文字があり、PHP中ではダブルクオーテーション文字 "\n" で示されます。
プロトコル実装
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)
{
// アンパック
$package_data = json_decode(trim($recv_buffer), true);
// ファイル名を取得
$file_name = $package_data['file_name'];
// base64_encodeされたファイルデータを取得
$file_data = $package_data['file_data'];
// base64_decodeして元のバイナリファイルデータに戻します
$file_data = base64_decode($file_data);
// データを返す
return array(
'file_name' => $file_name,
'file_data' => $file_data,
);
}
public static function encode($data)
{
// 必要に応じてクライアントに送信するデータをエンコードすることができます。本例ではテキストをそのまま返します。
return $data;
}
}
サーバプロトコル使用例
説明：バイナリアップロードと同様の書き方で、ほとんどビジネスコードを変更せずにプロトコルを切り替えることができます。
use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';
$worker = new Worker('TextTransfer://0.0.0.0:8333');
// ファイルを/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();クライアントファイル textclient.php （ここではphpを使用してクライアントのアップロードをシミュレート）
<?php
/** ファイルをアップロードするクライアント **/
// アップロード先
$address = "127.0.0.1:8333";
// アップロードファイルパスパラメータを確認
if(!isset($argv[1]))
{
exit("use php client.php \$file_path\n");
}
// アップロードするファイルパス
$file_to_transfer = trim($argv[1]);
// アップロードされるファイルがローカルに存在しない
if(!is_file($file_to_transfer))
{
exit("$file_to_transfer not exist\n");
}
// ソケット接続を作成
$client = stream_socket_client($address, $errno, $errmsg);
if(!$client)
{
exit("$errmsg\n");
}
stream_set_blocking($client, 1);
// ファイル名
$file_name = basename($file_to_transfer);
// ファイルのバイナリデータ
$file_data = file_get_contents($file_to_transfer);
// base64エンコード
$file_data = base64_encode($file_data);
// データパッケージ
$package_data = array(
'file_name' => $file_name,
'file_data' => $file_data,
);
// プロトコルパッケージ json+改行
$package = json_encode($package_data)."\n";
// アップロードを実行
fwrite($client, $package);
// 結果を出力
echo fread($client, 8192),"\n";クライアント使用例
コマンドラインで php textclient.php <ファイルパス> を実行
例えば php textclient.php abc.jpg