zither サーバのメソッド情報

Copyright (C) 2004-2007 Masashi Shimakura
Last Update: 04 07 2007

ここでは zither サーバをコントロールするためのメソッドの説明しています。
コネクション確立後にこれらのメソッドを送ることで zither サーバをコントロール出来ます。
これからクライアントを書いて頂ける方は参考にしてください。
現在 Windows 用クライアントを書いて頂ける方を探しています。

>モードについて

zither サーバには二段階のモードが存在します。
認証を通過する前と認証を通過後ではモードが異なります。
認証とは neg.conf に記載された内容を元に接続元のIPアドレスとユニークな名前によって判断されます。
これ以外にグローバルな設定をサーバ起動後に変更可能なadministratorモードが存在します。

>認証前モード

zither サーバには二段階のモードが存在します。
認証を通過する前と認証を通過後ではモードが異なります。
以下は認証前と認証のためのメソッドです。
telnet 等で確認できます。
注)name はクライアントの名前(C_NAME:)になります。
    最後に '-'がある場合は何でもいいが何か入れるという意味になります。

メソッド: VER method
確認    : name :: COM: VER DATA: -
答え    : zither サーバのヴァージョン情報を返します。
          失敗した場合は "500 NG" を返します。

メソッド: STAT method
確認    : name :: COM: STAT DATA: -
答え    : zither のバッファー情報を返します。
     デバッグ用ですので、relrase版にはすでに存在しないかもしれません。
     同様のメソッドは認証後も使用できます。
          失敗した場合は "500 NG" を返します。

メソッド: NEG method
確認    : name :: COM: NEG DATA: <監視クライアントのバージョン>,<クライアントの情報など>
答え    : 成功の場合認証モードに移行します。
          失敗した場合は接続を解除します。
     zither はクライアントのソースIPとnameを書いたneg.confに基づいて認証を許可します。

>認証後モード

メソッド: GET method
確認    : name :: COM: GET DATA: -
答え    : 以前存在したのですが現在は予備で、VER と同じ内容を返します。
          失敗した場合は 500 NG を返します。

メソッド: PUT method
確認    : name :: COM: PUT DATA: STAT:<ステートファイルの内容>
          name :: COM: PUT DATA: PORT:<ポート監視リストファイルの内容>
          name :: COM: PUT DATA: COMAND:<コマンド監視リストファイルの内容>
          name :: COM: PUT DATA: CONF:<クライアントコンフィグレーションファイルの内容>
答え    : サーバ側で管理している4種類のファイルがもしサーバ側に存在しない場合にクライアントにファイルが存在する場合は送付することが出来ます。
          送付するファイルの改行(\n)は"0x01" に置き換えてください、送るファイルサイズの上限はデフォルト2メガですが必要ならソースを書き換えてください。
          成功時は 200 OK 失敗した場合は 500 MG を返します。

メソッド: LIFE method
確認    : name :: COM: LIFE DATA: -
答え    : サーバ側でタイマーを動作させます。
     タイムアウトする前に再度LIFEメソッドを送らない場合にクライアントの動作不良と判断されエラーメールを送付します。
          LIFEを送るとサーバ側で管理される4種類のファイルに書き換えがあった場合に限りその旨を伝えます。
          内容は以下
          
           test :: COM: LIFE DATA: -
      CHECK_BAT_SCA_CONF_STAT 200 OK
  
      上記の場合4種類全てのファイルが書き換え又は存在しない可能性を示しています。    
          失敗した場合は 500 NG を返します。

メソッド: QUIT method
確認    : name :: COM: QUIT DATA: -
答え    : 接続を解除しその旨をエラーメールとして送付します。
          失敗した場合は 500 NG を返します。

メソッド: BAT method
確認    : name :: COM: BAT DATA: STAT
          name :: COM: BAT DATA: PORT
          name :: COM: BAT DATA: COMAND
          name :: COM: BAT DATA: CONF
答え    : LIFEの答えを元に4種類のファイルをクライアント側に落として来る場合に使われます。
          送られてくるファイルの改行(\n)は"0x01" に書き換えられています。
          失敗した場合は 500 NG を返します。

メソッド: ERR method
確認    : name :: COM: ERR DATA: <エラーの内容>
答え    : ここで送った内容はそのままエラーメールとして送付されます。
          送付するデータの改行(\n)は"0x01" に置き換えてください、送るファイルサイズの上限はデフォルト2メガですが必要ならソースを書き換えてください。
          失敗した場合は 500 NG を返します。

メソッド: SET method
確認    : name :: COM: SET DATA: MAIL_SERV:127.0.0.1
          name :: COM: SET DATA: MAIL_FROM:aaa@taro.xyz.org
          name :: COM: SET DATA: MAIL_RCPTTO:aaa@taro.xyz.org
          name :: COM: SET DATA: MAIL_CC:aaa@taro.xyz.org
          name :: COM: SET DATA: LIFE_INT:80
          name :: COM: SET DATA: LIFE_LOS:5

答え    : zither サーバ起動時に設定されているコンフィグレーションの一部をクライアント側から任意に変更できます。
     サーバは接続時にスレッド分岐しているので他の接続には影響ありません。
          成功時は 200 OK 失敗した場合は 500 NG を返します。

>administratorモード

メソッド: SETG method
確認    : administrator :: COM: SETG: DATA: MAIL_SERV:127.0.0.1
          administrator :: COM: SETG: DATA: MAIL_RCPTTO:aaa@taro.xyz.org
          administrator :: COM: SETG: DATA: MAIL_FROM:aaa@taro.xyz.org
          administrator :: COM: SETG: DATA: MAIL_CC:aaa@taro.xyz.org
          administrator :: COM: SETG: DATA: MAIL_ONOFF:1 又は 0

答え    : zither サーバ起動時のコンフィグレーションファイルの内容の一部を後得的に変更可能です。
     変更の影響は変更後接続したクライアント全てにおよぶので注意が必要です。
     変更が可能なユーザ名はadministratorに固定されています。

zither2.jpg(13489 byte) zither.ms-n.comにもどるです。