HTTPメッセージハンドラ

HttpMessageHandler の使い方は、TCPメッセージサーバーに準拠しているが、HTTP上でメッセージングを実現するためにいくつかの制約を設けている:

• cookie または querystring にセッションIDを含めることで、HTTPセッションを導入している。
• 一つの HTTP リクエストに、一つだけのメッセージを含めることができる。
• リクエストメッセージは、querystring または HTTP POST の本文に JSON 直列化したものを記述する。
• HTTP 応答は一つ以上のメッセージを含めることができる。
• HTTP応答のメッセージは応答の本文に記述する。メッセージは JSON 配列に直列化する。
• HTTP要求を処理している時だけ、post() でのメッセージ送信を行うことができる。
• セッションが維持されている間はいつでも queue() で送信メッセージをキューイングすることができる。
• flow() を呼んだ時の HTTP応答で、キューイングされたメッセージを送信する。

HttpMessageHandler 定義から、一般的に使う部分を抜き出すと次のようになっている:

class HttpMessageHandler: public HttpHandler
{
   public:
      bool initialize(const HttpMessageHandlerConfig* pCfg);

      virtual void turn(); //!< HTTPセッションの時間切れ判定を行う

      virtual bool handleMessage(Message* pMsg);
      bool post(int sid, const Message*, const SendContext* = NULL);
      bool queue(int sid, Message*, const SendContext* = NULL);
      bool flow(int sid);

      void closeLater(int sid);
      virtual void onSessionOpen(int sid);
      virtual void onSessionClose(int sid);
};

パラメータに与える HttpMessageHandlerConfig 構造体は次のように定義されている:

struct HttpMessageHandlerConfig
{
      int nSessions; //!< セッションの数
      int sessionTimeoutSec; //!< 次のHTTPリクエストが来るまでセッションを維持する時間[秒]

      // sessionCookie か sessionQueryString のどちらかの指定は必須
      std::string sessionCookie; //!< セッション情報を保持する cookie 名を指定。
      std::string sessionCookiePath; //!< セッション用 cookie のパス
      std::string sessionCookieDomain; //!< セッション用 cookie のドメイン
      std::string sessionQueryString; //!< セッション情報を保持する querystring の key を指定。

      std::string jsonp; //!< 応答を JSONP 形式で行う。JSONP関数名を保持する key を指定。

      // enableQueryStringMarshal か enablePostMarshal のどちらかの指定は必須
      bool enableQueryStringMarshal; //!< QueryString へのメッセージ直列化を処理する
      bool enablePostMarshal; //!< POST Body へのメッセージ直列化を処理する

nSessions

HTTPセッションの最大数を指定する。

HTTPセッションは、HTTP接続が切れていてもタイムアウトまでは存続することを考慮して、適切な値を指定する。

sessionTimeoutSec

HTTP セッションのタイムアウト時間。

タイムアウトは、HTTP応答を返してから、次の HTTP 要求が来るまでの間で計測される。

sessionCookie

HTTPセッションの識別子を cookie に載せることとし、その cookie の名前を指定する。

sessionCookie か sessionQueryString のどちらかの指定は必須である。

sessionCookiePath, sessionCookieDomain

HTTPセッション用 cookie のパスとドメインを指定する。

sessionQueryString

HTTPセッションの識別子を QueryString に載せることとし、その key の名前を指定する。

sessionCookie か sessionQueryString のどちらかの指定は必須である。

jsonp

メッセージの応答を JSONP 形式にする。その JSONP の関数名を指定する。

enableQueryStringMarshal

リクエストメッセージの直列化を QueryString で行う。

enableQueryStringMarshal か enablePostMarshal のどちらかの指定は必須である。

enablePostMarshal

リクエストメッセージの直列化を HTTP POST の本文で行う。

enableQueryStringMarshal か enablePostMarshal のどちらかの指定は必須である。