通信プロトコル規約

概要

クライアントとサーバの通信にあたり、サーバ側でどのように通信処理させるかの

規約を設け今後の機能追加に対応できるようにする。

基本プロトコル

AAA BBB CCC

DDD

DDD

EEE

EEE

EEE

FFFFFFF

改行コード

\r\n

コード内容

AAA

必須

対象となるコンポーネント名

例）チャットの場合、「CHAT」

BBB

必須

命令コード

例）チャットのメッセージの場合、「MASSAGE」

CCC

必須

バージョン(数値のみ)

例）チャットコンポーネントのバージョン、「1.0」

DDD

必須

サーバ確認コード(改行で複数記載)

FROM-ID

必須

サーバで管理している送信元ID

例）FROM-ID:XXXXXX

PROJECT-ID

必須

サーバで管理しているプロジェクトID

例）PROJECT-ID:XXXXXX

EEE

任意

サーバ命令コード(改行で複数記載)

TO-ID

任意

サーバで管理している送信先ID。(カンマ区切り)※1

例）TO-ID:XXXXXX,YYYYYY

FILE-NAME

任意

ファイル名：ファイル名

例）FILE-NAME:chat.log

FILE-NAME2

任意

ファイル名：何らかの操作後のファイル名

例）FILE-NAME2:log\chat20090412.log

MAKE-POINT

任意

ALL-PROJECT：全プロジェクト共通フォルダの各ユーザー

フォルダに作成

ALL-USER：各プロジェクトフォルダの全ユーザ共通フォルダ

に作成

EACH：各プロジェクトフォルダの各ユーザーフォルダに作成

未指定の場合はEACHとする

※各カクユーザフォルダはTO-IDを対象タイショウとする。

例）MAKE-POINT:EACH

FILE-ACTION

任意

CREATE：新規作成、上書き保存

APPEND：新規作成、追加保存

DELETE：削除

READ：読み取り

RENAME：ファイル名変更、ディレクトリ変更

LIST：ファイル一覧を返す(サブディレクトリを含む)

未指定の場合は何もしない

例）FILE-ACTION:CREATE

FILE-TYPE

任意

ASC：保存するファイルが文字の場合

BINARY：保存するファイルがバイナリの場合

未指定の場合はASCとする

例）FILE-TYPE:ASC

※クライアントに送信する内容からこのコードは外す

FFFFFF

任意

データ情報

例）チャットのメッセージの場合、「こんにちは」

※1

TO-IDが指定されていない場合

TO-IDが指定されている場合