Reference | SOCKET-MANAGER Framework For PHP

SocketManagerParameter
in package

Application

implements IUnitParameter

UNITパラメータの基底クラス

周期ドリブンマネージャーへ引き渡すパラメータの管理と制御を行う

Interfaces

IUnitParameter: UNITパラメータインタフェース

Properties

$cid : string|null: 接続ID
$kind : string|null: 周期ドリブンマネージャーの種別 'protocol_names' or 'command_names'
$lang : string: 言語設定
$manager : SocketManager|null: ソケットマネージャー
$protocol : ProtocolParameter|null: プロトコルUNITパラメータ

Methods

__construct() : mixed: コンストラクタ
__get() : mixed: getterメソッドの呼び出し
aliveCheck() : mixed: アライブチェックを行う
changeQueue() : mixed: キューの切り替え
close() : mixed: 切断シーケンス開始（プロトコルユニットの'CLOSE'キューを実行）
emergencyShutdown() : mixed: 緊急停止（即時切断）
getAwaitConnectionId() : string|null: 待ち受けポートの接続IDの取得
getAwaitHost() : string|null: 待ち受けホスト名を取得
getAwaitPort() : int|null: 待ち受けポート番号を取得
getClientCount() : int: 現在のユーザー数を取得
getCloseParameter() : mixed: 切断パラメータ（切断シーケンスによって登録されたパラメータ）の取得
getConnectionId() : string: 接続IDの取得
getForcedDispatcher() : bool: 強制ディスパッチャーフラグの取得
getKindString() : string: 周期ドリブンマネージャーの種別取得
getLanguage() : string: 言語コードの取得
getQueueName() : string|null: キュー名の取得
getRecvData() : mixed: 処理対象の受信データを取得
getSocketManager() : SocketManager|null: ソケットマネージャーの取得
getStatusName() : string|null: ステータス名の取得
getTempBuff() : mixed: テンポラリバッファの取得
isExecutedQueue() : bool: キューの実行状況を検査
isReceiving() : bool: データ受信中の検査
isSending() : bool: データ送信中の検査
logWriter() : mixed: ログライター
protocol() : IProtocolParameter: IProtocolParameterインタフェースの取得
setConnectionId() : mixed: 接続IDの設定
setForcedDispatcher() : mixed: 強制ディスパッチャーフラグの設定
setKindString() : mixed: 周期ドリブンマネージャーの種別設定
setLanguage() : mixed: 言語コードの設定
setRecvData() : mixed: 処理対象の受信データを設定
setRecvStack() : mixed: 受信データスタックへ設定
setSendStack() : mixed: 送信データスタックへ設定
setSendStackAll() : mixed: 全接続の送信データスタックへ設定
setSocketManager() : mixed: ソケットマネージャーの設定
setStatusName() : mixed: ステータス名の設定
setTempBuff() : mixed: テンポラリバッファの設定
throwBreak() : mixed: プロトコルUNIT処理を中断する

$cid

接続ID


    private
        string|null
    $cid
     = null

$kind

周期ドリブンマネージャーの種別 'protocol_names' or 'command_names'


    private
        string|null
    $kind
     = null

$lang

言語設定


    private
        string
    $lang
     = 'ja'

デフォルト：'ja'

$manager

ソケットマネージャー


    private
        SocketManager|null
    $manager
     = null

$protocol

プロトコルUNITパラメータ


    private
        ProtocolParameter|null
    $protocol
     = null

__construct()

コンストラクタ


    public
                    __construct([string $p_lang = null ]) : mixed

Parameters

$p_lang : string = null: 言語コード

__get()

getterメソッドの呼び出し


    public
        final            __get(mixed $p_name) : mixed

Parameters

$p_name : mixed

aliveCheck()

アライブチェックを行う


    public
        final            aliveCheck(int $p_tout) : mixed

任意のタイミングで一時的に実行したい時に利用する

※既に設定済みの場合は何もせずに終了する

※実行後スローブレイクすることに注意

Parameters

$p_tout : int: — アライブチェックタイムアウト（秒）

changeQueue()

キューの切り替え


    public
        final            changeQueue(string|null $p_name) : mixed

Parameters

$p_name : string|null: キュー名（null時はアイドリングに戻す）

close()

切断シーケンス開始（プロトコルユニットの'CLOSE'キューを実行）


    public
        final            close(mixed $p_param[, bool|null $p_convert = null ]) : mixed

プロトコルUNIT実行中に呼ばれた場合は例外を投げて現在の処理を中断する

※基本的に切断情報バッファ内のペイロードデータはシリアライズ化されている事を前提とする

Parameters

$p_param : mixed: 切断時パラメータ
$p_convert : bool|null = null: ― 変換（シリアライズ／アンシリアライズの行使）フラグ

― null（指定なし）の場合は自動判別（プロトコルUNITでの実行：false、コマンドUNITでの実行：true）

― フラグ指定に関わらずシリアライザーが登録されていなければ変換はされない

emergencyShutdown()

緊急停止（即時切断）


    public
        final            emergencyShutdown() : mixed

getAwaitConnectionId()

待ち受けポートの接続IDの取得


    public
        final            getAwaitConnectionId() : string|null

Return values

string|null —

待ち受けポートの接続ID

getAwaitHost()

待ち受けホスト名を取得


    public
        final            getAwaitHost() : string|null

Return values

string|null —

待ち受けホスト名

getAwaitPort()

待ち受けポート番号を取得


    public
        final            getAwaitPort() : int|null

Return values

int|null —

待ち受けポート番号

getClientCount()

現在のユーザー数を取得


    public
        final            getClientCount() : int

Return values

int —

ユーザー数

getCloseParameter()

切断パラメータ（切断シーケンスによって登録されたパラメータ）の取得


    public
        final            getCloseParameter([bool|null $p_convert = null ]) : mixed

※基本的に切断情報バッファ内のペイロードデータはシリアライズ化されている事を前提とする

Parameters

$p_convert : bool|null = null: ― 変換（シリアライズ／アンシリアライズの行使）フラグ

― null（指定なし）の場合は自動判別（プロトコルUNITでの実行：false、コマンドUNITでの実行：true）

― フラグ指定に関わらずシリアライザーが登録されていなければ変換はされない

Return values

mixed —

切断パラメータ or null（空）

getConnectionId()

接続IDの取得


    public
        final            getConnectionId() : string

Return values

string —

接続ID

getForcedDispatcher()

強制ディスパッチャーフラグの取得


    public
        final            getForcedDispatcher() : bool

Return values

bool —

true（強制ディスパッチ） or false（ディスパッチなし）

getKindString()

周期ドリブンマネージャーの種別取得


    public
        final            getKindString() : string

Return values

string —

種別文字列（'protocol_names' or 'command_names'）

getLanguage()

言語コードの取得


    public
        final            getLanguage() : string

Return values

string —

言語コード

getQueueName()

キュー名の取得


    public
        final            getQueueName() : string|null

Return values

string|null —

キュー名 or null（なし）

getRecvData()

処理対象の受信データを取得


    public
        final            getRecvData() : mixed

Return values

mixed —

受信データ or null（データなし）

getSocketManager()

ソケットマネージャーの取得


    public
        final            getSocketManager() : SocketManager|null

Return values

SocketManager|null —

ソケットマネージャーのインスタンス

getStatusName()

ステータス名の取得


    public
        final            getStatusName() : string|null

Return values

string|null —

ステータス名 or null（なし）

getTempBuff()

テンポラリバッファの取得


    public
        final            getTempBuff(array<string|int, mixed> $p_prop[, string|null $p_cid = null ]) : mixed

Parameters

$p_prop : array<string|int, mixed>: プロパティ（キー）のリスト
$p_cid : string|null = null: 接続ID

Return values

mixed —

バッファデータ or null（空）

isExecutedQueue()

キューの実行状況を検査


    public
        final            isExecutedQueue(string $p_que) : bool

Parameters

$p_que : string: キュー名

Return values

bool —

true（実行中） or false（停止中）

isReceiving()

データ受信中の検査


    public
        final            isReceiving() : bool

Return values

bool —

true（受信中） or false（受信中ではない）

isSending()

データ送信中の検査


    public
        final            isSending() : bool

Return values

bool —

true（送信中） or false（送信中ではない）

logWriter()

ログライター


    public
        final            logWriter(string $p_level, array<string|int, mixed> $p_param) : mixed

SocketManagerで使用しているログライターと同じ

Parameters

$p_level : string: ログレベル
$p_param : array<string|int, mixed>: ログパラメータ

protocol()

IProtocolParameterインタフェースの取得


    public
        final            protocol() : IProtocolParameter

Return values

IProtocolParameter

setConnectionId()

接続IDの設定


    public
        final            setConnectionId(string $p_cid) : mixed

Parameters

$p_cid : string: 接続ID

setForcedDispatcher()

強制ディスパッチャーフラグの設定


    public
        final            setForcedDispatcher(bool $p_flag) : mixed

Parameters

$p_flag : bool

setKindString()

周期ドリブンマネージャーの種別設定


    public
        final            setKindString(string $p_kind) : mixed

Parameters

$p_kind : string: 種別文字列（'protocol_names' or 'command_names'）

setLanguage()

言語コードの設定


    public
        final            setLanguage(string $p_lang) : mixed

Parameters

$p_lang : string

setRecvData()

処理対象の受信データを設定


    public
        final            setRecvData(mixed $p_dat[, string|null $p_cid = null ]) : mixed

Parameters

$p_dat : mixed
$p_cid : string|null = null: 設定したい接続ID

setRecvStack()

受信データスタックへ設定


    public
        final            setRecvStack([mixed $p_data = null ][, bool|null $p_convert = null ][, string $p_cid = null ]) : mixed

※基本的に送受信スタック内のペイロードデータはシリアライズ化されている事を前提とする

Parameters

$p_data : mixed = null: 設定するデータ
$p_convert : bool|null = null: ― 変換（シリアライズ／アンシリアライズの行使）フラグ

― null（指定なし）の場合は自動判別（プロトコルUNITでの実行：false、コマンドUNITでの実行：true）

― フラグ指定に関わらずシリアライザーが登録されていなければ変換はされない
$p_cid : string = null: 設定したい接続ID

setSendStack()

送信データスタックへ設定


    public
        final            setSendStack([mixed $p_data = null ][, string $p_cid = null ]) : mixed

※基本的に送受信スタック内のペイロードデータはシリアライズ化されている事を前提とする

Parameters

$p_data : mixed = null: 設定するデータ
$p_cid : string = null: 設定したい接続ID

setSendStackAll()

全接続の送信データスタックへ設定


    public
        final            setSendStackAll(mixed $p_data[, bool $p_self_remove = false ][, mixed $p_fnc = null ][, mixed $p_param = null ]) : mixed

※基本的に送受信スタック内のペイロードデータはシリアライズ化されている事を前提とする

Parameters

$p_data : mixed: 送信データ
$p_self_remove : bool = false: 自身のディスクリプタの除外フラグ
$p_fnc : mixed = null: 処理対象の接続ID評価コールバック
$p_param : mixed = null: コールバックのパラメータ

setSocketManager()

ソケットマネージャーの設定


    public
        final            setSocketManager(SocketManager $p_mng) : mixed

Parameters

$p_mng : SocketManager: ソケットマネージャーのインスタンス

setStatusName()

ステータス名の設定


    public
        final            setStatusName(string|null $p_name) : mixed

Parameters

$p_name : string|null

setTempBuff()

テンポラリバッファの設定


    public
        final            setTempBuff(array<string|int, mixed> $p_prop[, string|null $p_cid = null ]) : mixed

Parameters

$p_prop : array<string|int, mixed>: プロパティのリスト
$p_cid : string|null = null: 接続ID

throwBreak()

プロトコルUNIT処理を中断する


    public
        final            throwBreak() : mixed

実行されると例外キャッチ時に切断処理は無視されて処理を継続する

SocketManagerParameter in package Application implements IUnitParameter

Table of Contents

Interfaces

Properties

Methods

Properties

$cid

$kind

$lang

$manager

$protocol

Methods

__construct()

Parameters

__get()

Parameters

aliveCheck()

Parameters

changeQueue()

Parameters

close()

Parameters

emergencyShutdown()

getAwaitConnectionId()

Return values

getAwaitHost()

Return values

getAwaitPort()

Return values

getClientCount()

Return values

getCloseParameter()

Parameters

Return values

getConnectionId()

Return values

getForcedDispatcher()

Return values

getKindString()

Return values

getLanguage()

Return values

getQueueName()

Return values

getRecvData()

Return values

getSocketManager()

Return values

getStatusName()

Return values

getTempBuff()

Parameters

Return values

isExecutedQueue()

Parameters

Return values

isReceiving()

Return values

isSending()

Return values

logWriter()

Parameters

protocol()

Return values

setConnectionId()

Parameters

setForcedDispatcher()

Parameters

setKindString()

Parameters

setLanguage()

Parameters

setRecvData()

Parameters

setRecvStack()

Parameters

setSendStack()

Parameters

setSendStackAll()

Parameters

SocketManagerParameter
in package

Application

implements IUnitParameter