Skip to content

Yairc(仮) プロトコル仕様

makamaka edited this page May 24, 2012 · 1 revision

機能概要

ぼくのかんがえたさいきょうのちゃっとしすてむ を実現するためのチャットプロトコルの仕様

通信の実装

socket.ioを使う

認証(Authentication)

システムはチャット参加のためにクライアントに認証を求める。認証方法はサーバ実装依存である。

認証が済んだクライアントにはサーバからtoken(「userオブジェクト」参照)が発行される。 認証完了時、サーバはアクセスユーザー毎に一意なid:user_key(「userオブジェクト」参照)を設定する。

認証を通じてチャットに参加するので認可も兼ねてるか。

クライアントが発行する(サーバが受ける)イベント

user message

token login

join tag

server info

サーバが発行する(クライアントが受ける)イベント

nicknames

announcement

token login

join tag

user message

server info

ユーザーオブジェクト (user)

user_key

nickname

profile_image_url

token

投稿オブジェクト (post)

id

text

nickname

user_key

tags

created_at_ms

profile_image_url

タグの仕様

post.text内で下記の正規表現で表される文字列はタグとして取り扱う

正規表現

/(^| )#[a-zA-Z0-9]+( |$)/mg

将来的にはマルチバイトなのも含むかも

text内に含められるタグの最大数

  • 10

一つのタグの最大字数

  • 32

※シャープは含めない

検索時の動作

完全一致