IInitSocketManager
in
SocketManagerクラス初期化用インタフェース
SocketManagerクラス初期化時にインプリメントしてsetInitSocketManagerメソッドへ渡すための定義
※グローバル関数名指定も可
Table of Contents
Methods
- getCommandDispatcher() : mixed
- コマンドディスパッチャーの取得
- getEmergencyCallback() : mixed
- 緊急停止時のコールバックの取得
- getLogWriter() : mixed
- ログライターの取得
- getSerializer() : mixed
- シリアライザーの取得
- getUnitParameter() : SocketManagerParameter|null
- UNITパラメータインスタンスの取得
- getUnserializer() : mixed
- アンシリアライザーの取得
Methods
getCommandDispatcher()
コマンドディスパッチャーの取得
public
getCommandDispatcher() : mixed
受信データからコマンドを解析して返す
コマンドUNIT実行中に受信データが溜まっていた場合でもコマンドUNITの処理が完了するまで 待ってから起動されるため処理競合の調停役を兼ねる。
nullを返した場合は無効化される。エラー発生時はUnitExceptionクラスで例外をスローして切断する。
Return values
mixed —"function(SocketManagerParameter $p_param, mixed $p_dat): ?string" or null（ディスパッチ機能なし）
【コマンドディスパッチャー関数仕様】
引数1：SocketManagerParameter（※1） $p_param UNITパラメータ
引数2：mixed $p_dat 受信データ（ペイロード部）
戻り値：?string コマンドUNITのキュー名 or null（変更なし）
（※1）当該クラス、あるいは当該クラスを継承したクラスも指定可
getEmergencyCallback()
緊急停止時のコールバックの取得
public
getEmergencyCallback() : mixed
UNIT処理以外で緊急切断が発生した場合に実行される。
発生要因⇒相手先による切断・コマンドディスパッチャーでの例外発生・アライブチェックタイムアウト
※nullを返した場合は無効化される。
Return values
mixed —"function(SocketManagerParameter $p_param)" or null（緊急停止時処理なし）
【緊急停止時のコールバック関数仕様】
引数1：SocketManagerParameter（※1） $p_param UNITパラメータ
戻り値：なし
（※1）当該クラス、あるいは当該クラスを継承したクラスも指定可
getLogWriter()
ログライターの取得
public
getLogWriter() : mixed
nullを返した場合は無効化される（但し、ライブラリ内部で出力されているエラーメッセージも出力されない）
Return values
mixed —"function(string $p_level, array $p_param): void" or null（ログ出力なし）
【ログライター関数仕様】
引数1：string $p_level ログレベル（※1）
引数2：array $p_param ログパラメータ
戻り値：なし
（※1）当該ライブラリで使用しているレベル種別⇒"debug" or "info" or "notice" or "warning" or "error"
getSerializer()
シリアライザーの取得
public
getSerializer() : mixed
nullを返した場合は無効化される。 エラー発生時はUnitExceptionクラスで例外をスローして切断する。
Return values
mixed —"function(mixed $p_data): mixed" or null（シリアライズなし）
【シリアライザー関数仕様（※1）】
引数1：mixed $p_data シリアライズ対象ペイロードデータ
戻り値：mixed シリアライズデータ
（※1）送受信データスタック内のデータが対象
getUnitParameter()
UNITパラメータインスタンスの取得
public
getUnitParameter() : SocketManagerParameter|null
nullを返した場合はSocketManagerParameterのインスタンスが適用される
Return values
SocketManagerParameter|null —― SocketManagerParameterクラスのインスタンス
― 当該クラス、あるいは当該クラスを継承したクラスも指定可
getUnserializer()
アンシリアライザーの取得
public
getUnserializer() : mixed
nullを返した場合は無効化される。 エラー発生時はUnitExceptionクラスで例外をスローして切断する。
Return values
mixed —"function(mixed $p_data): mixed" or null（アンシリアライズなし）
【アンシリアライザー関数仕様（※1）】
引数1：mixed $p_data アンシリアライズ対象ペイロードデータ
戻り値：mixed アンシリアライズデータ
（※1）送受信データスタック内のデータが対象