Public メソッド | Public 変数

クラス PGClientSocket

クライアント宛通信ソケット [詳細]

#include <PGClientSocket.h>

PGClientSocketに対する継承グラフ
PGClientSocketのコラボレーション図

すべてのメンバ一覧

Public メソッド

 PGClientSocket (SGStream *stream, SGFdDataList *list)
 コンストラクタ
 ~PGClientSocket ()
 デストラクタ
virtual int SendData (const SGString &json)
 JSON 文字列送信.
virtual int OnReceive (struct sockaddr *addr, socklen_t addrlen)
 受信時コールバック関数
virtual void OnClose ()
 クローズ時コールバック関数
SGStringGetSessionId ()
 セッションIDの取得
bool CompareSessionId (const SGString &sessionid)
 セッションIDの確認
bool CompareDialogName (const SGString &dialogname)
 ダイアログ名の確認
void Authentication (const SGString sessionid)
 認証
bool DoCommand (const SGString &json)
 コマンド実行
void OnGetfile (SGString file, SGString date, SGString objectname)
 GETFILEコマンド受信通知.

Public 変数

SGString mDialogName
 カレントダイアログ名

説明

クライアント宛通信ソケット

接続要求によって確立されたクライアントとの通信ソケットです。


コンストラクタとデストラクタ

PGClientSocket ( SGStream stream,
SGFdDataList list 
)

コンストラクタ

引数:
stream ログ出力先ストリーム
list 入出力ディスクリプタリスト
~PGClientSocket (  ) 

デストラクタ


関数

int SendData ( const SGString json  )  [virtual]

JSON 文字列送信.

クライアント宛に JSON 文字列を送信します。

引数:
json JSON 文字列
戻り値:
Send 関数の戻り値を返します。
int OnReceive ( struct sockaddr *  addr,
socklen_t  addrlen 
) [virtual]

受信時コールバック関数

データ受信後に呼ばれます。 受信データは内部バッファに連結され、DoCommand 関数が呼ばれます。

注意:
addr が NULL 、 addrlen が 0 の時があるので注意すること。
引数:
addr 送信元アドレス
addrlen addr の長さ
戻り値:
常に 0 を返します。

SGSocketを再定義しています。

void OnClose (  )  [virtual]

クローズ時コールバック関数

クローズ後に呼ばれます。

SGClientSocketを再定義しています。

SGString & GetSessionId (  ) 

セッションIDの取得

セッションIDを取得します。

戻り値:
セッションID
bool CompareSessionId ( const SGString sessionid  ) 

セッションIDの確認

指定のセッションIDがこのソケットのものとして有効か無効かを確認します。

戻り値:
true このセッションIDはこのソケットのものとして有効です。
false このセッションIDはこのソケットのものとして無効です。
bool CompareDialogName ( const SGString dialogname  ) 

ダイアログ名の確認

指定のダイアログ名がこのソケットのものとして有効か無効かを確認します。

戻り値:
true このダイアログ名はこのソケットのものとして有効です。
false このダイアログ名はこのソケットのものとして無効です。
void Authentication ( const SGString  sessionid  ) 

認証

このソケットにセッションIDを登録し「認証済み」状態とします。

引数:
sessionid 認証確認済みのセッションID
bool DoCommand ( const SGString json  ) 

コマンド実行

受信した JSON 文字列中にあるコマンドを解析して実行します。

引数:
json JSON 文字列
戻り値:
常に true を返します。
void OnGetfile ( SGString  file,
SGString  date,
SGString  objectname 
)

GETFILEコマンド受信通知.

GETFILEコマンドを受信した時に呼び出されます。
パラメータの objectname は端末が PUTFILE コマンドを受信した時に通知するオブジェクト名がセットされています。
PUTFILE コマンドを送信する時、要素名「ObjectName」として付加します。
通常、サーバは GETFILE コマンドを受信すると、指定されたファイルを読込み、PUTFILE コマンドとして送信します。
例外として、ファイルがJSONでかつ、そのダイアログのリソースが既に読込まれている場合は、ファイルを読まずに保持している リソースを送信する場合がある為、対応のダイアログクラスの OnGetfile をコールし、処理をダイアログに任せます。
※DELETEやADD機能により、ファイルとリソースに差異がある場合があるので、ダイアログリソースは常に最新の状態を返す必要があります。

引数:
file ファイル名
date 端末にあるファイルの日時
objectname 端末が PUTFILE コマンドを受信した時に通知するオブジェクト名

変数

カレントダイアログ名


このクラスの説明は次のファイルから生成されました:

PlusG SMART Solution リファレンスマニュアル Ver 1.0.0