shogi-serverのAPIドキュメントを読もうぜ（＾～＾）？

ヘッヘー（＾▽＾）！公開下書き

shogi-serverのAPIドキュメントを読もうぜ（＾～＾）？

「　さっき作った APIドキュメント読もうぜ？」

「　勝手に読めだぜ」

「　構成図でもあると　あとで便利かしら？」

Classes and Modules

マッチングに関するもの

ShogiServer::Pairing
- ShogiServer::DeleteLeastRatePlayer
- ShogiServer::DeleteMostPlayingPlayer
- ShogiServer::DeletePlayerAtRandom
- ShogiServer::DeletePlayerAtRandomExcept
- ShogiServer::ExcludeSacrifice
  - ShogiServer::ExcludeSacrificeGps500
- ShogiServer::ExcludeUnratedPlayers
- ShogiServer::LeastDiff
- ShogiServer::LogPlayers
- ShogiServer::MakeEven
- ShogiServer::Randomize
- ShogiServer::SortByRate
- ShogiServer::SortByRateWithRandomness
- ShogiServer::Swiss
- ShogiServer::AbstractStartGame
  - ShogiServer::StartGame
  - ShogiServer::StartGameWithoutHumans

レーティングの計算に関するもの

成績の統計に関するもの
- Monthly
- State
- Values
レーティング計算に関するもの
- Rating
- Record
- WinLossMatrix

対局の記録に関するもの

対局状況
- ShogiServer::Game
選手の状態、成績に関するもの
- ShogiServer::BasicPlayer
  - ShogiServer::Player
  - SimplePlayer
対局の結果に関するもの
- ShogiServer::GameResult
  - ShogiServer::GameResultWin
    - ShogiServer::GameResultAbnormalWin
    - ShogiServer::GameResultIllegalWin
      - ShogiServer::GameResultIllegalKachiWin
      - ShogiServer::GameResultIllegalMoveWin
      - ShogiServer::GameResultOuteKaihiMoreWin
      - ShogiServer::GameResultOuteSennichiteWin
      - ShogiServer::GameResultOutoriWin
    - ShogiServer::GameResultKachiWin
    - ShogiServer::GameResultTimeoutWin
    - ShogiServer::GameResultToryoWin
    - ShogiServer::GameResultUchifuzumeWin
  - ShogiServer::GameResultDraw
    - ShogiServer::GameResultMaxMovesDraw
    - ShogiServer::GameResultSennichiteDraw
  - ShogiServer::MonitorObserver
- ShogiServer::LoggingObserver

通信に関するもの

BaseClient
- CSABaseClient

USI、CSAプロトコルに関するもの

BridgeState
ShogiServer::Usi
ShogiServer::Usi::CsaToUsi
ShogiServer::Usi::UsiToCsa

ユーザー・サポートに関するもの

バグ修正に関するもの
- CheckCsaFile

表示に関するもの

評価値グラフ？
- EvalGraph
- EvalGraph::Player
  - EvalGraph::Black
  - EvalGraph::White
プレイヤーの成績グラフ？
- Format
- LargeFormat
  - LargePngFormat
  - SvgFormat
- SmallPngFormat

Webサーバーに関するもの

ListServlet
WhoServlet
ShogiClient
Ramazeフレームワークに関するもの
- MainController

対局中に関するもの

盤に関するもの
- ShogiServer::Board
  - ShogiServer::HC10PBoard - 以下、駒落ち局面に関するもの
  - ShogiServer::HC2PBoard
  - ShogiServer::HC4PBoard
  - ShogiServer::HC6PBoard
  - ShogiServer::HC8PBoard
  - ShogiServer::HCHIBoard
  - ShogiServer::HCHIKYBoard
  - ShogiServer::HCKABoard
  - ShogiServer::HCKYBoard
指し手に関するもの
- ShogiServer::Move
駒に関するもの
- ShogiServer::Piece
  - ShogiServer::PieceFU
  - ShogiServer::PieceGI
  - ShogiServer::PieceHI
  - ShogiServer::PieceKA
  - ShogiServer::PieceKE
  - ShogiServer::PieceKI
  - ShogiServer::PieceKY
  - ShogiServer::PieceOU
対局時計に関するもの
- ShogiServer::TimeClock
  - ShogiServer::ChessClock
  - ShogiServer::ChessClockWithLeastZero
  - ShogiServer::StopWatchClock

マンマシンインターフェースに関するもの

コマンドをオブジェクトにするもの
- ShogiServer::Command
- ShogiServer::AgreeCommand
- ShogiServer::BaseCommandForGame
  - ShogiServer::Monitor2OnCommand
  - ShogiServer::MonitorOffCommand
    - ShogiServer::Monitor2OffCommand
  - ShogiServer::MonitorOnCommand
- ShogiServer::ChallengeCommand
- ShogiServer::ChatCommand
- ShogiServer::DeleteBuoyCommand
- ShogiServer::ErrorCommand
- ShogiServer::ExceptionCommand
- ShogiServer::ForkCommand
- ShogiServer::GameChallengeCommand
- ShogiServer::GameCommand
- ShogiServer::GetBuoyCountCommand
- ShogiServer::HelpCommand
- ShogiServer::ListCommand
- ShogiServer::LogoutCommand
- ShogiServer::MoveCommand
- ShogiServer::RatingCommand
- ShogiServer::RejectCommand
- ShogiServer::SetBuoyCommand
- ShogiServer::ShowCommand
- ShogiServer::SpaceCommand
- ShogiServer::SpecialCommand
- ShogiServer::VersionCommand
- ShogiServer::VoidCommand
- ShogiServer::WhoCommand
コマンドを監視している？
- ShogiServer::MonitorHandler
  - ShogiServer::MonitorHandler1
  - ShogiServer::MonitorHandler2

大会に関するもの

ShogiServer::League
ShogiServer::League::Floodgate
ShogiServer::League::Floodgate::AbstructNextTimeGenerator
- ShogiServer::League::Floodgate::NextTimeGenerator_Debug
- ShogiServer::League::Floodgate::NextTimeGenerator_Floodgate_3600_0
- ShogiServer::League::Floodgate::NextTimeGenerator_Floodgate_900_0
ShogiServer::League::Floodgate::History
ShogiServer::League::Floodgate::NextTimeGenerator
- ShogiServer::League::Floodgate::NextTimeGeneratorConfig
ShogiServer::League::Persistent

対局サーバーに関するもの

ShogiServer -対局サーバー
設定ファイルに関するもの
- ShogiServer::Config
初期化処理に関するもの？
- ShogiServer::SetupFloodgate - フラッドゲートサーバー起動時の初期化処理か？
- MySetupFloodgate
ログインに関するもの
- ShogiServer::Login
  - ShogiServer::LoginCSA
  - ShogiServer::Loginx1

showgame？に関するもの

ShogiGraphic
ShogiGraphic::Client
ShogiGraphic::Processor
ShogiGraphic::Usi2png_args
ShogiGraphic::Usi2png_result

どこででも使うもの

Array - どこででも使うぜ
Hash - ハッシュテーブル。config.rbにあるのが気になるが
- HashWithIndifferentAccess
Object
ShogiServer::Mkdir
Time
ログに関するもの
- ShogiServer::Logger
  - BridgeFormatter
  - ShogiServer::Formatter - 将棋サーバーのログ書式
ファイルに関するもの
- CsaFileReader
Ruby言語でのプログラミングに関するもの
- ShogiServer::WrongMoves - 例外クラス
その他
- ShogiServer::TimeoutQueue - Playerクラスが文字を書き出すのに使ってる？

指定局面（Buoy）戦に関するもの

ShogiServer::Buoy
ShogiServer::BuoyGame
- ShogiServer::NilBuoyGame

品質管理、テストに関するもの

ベンチマークに関するもの
- BenchGame
- BenchPlayer
SocketPlayer
- SocketCSAPlayer
BaseTestBuoyCommand
DummyPlayer
MockGame
MockLeague
MockLogger
MockPlayer
RatingTest
ReadFileClient
- JishogiTest
- MaxMovesTest
- NotSennichiteTest
- OuteSennichiteTest
- UchifuzumeTest
テストケースのもの
- TestAgreeCommand
- TestBeforeAgree
- TestBoardForBuoy
- TestBuoy
- TestBuoyGame
- TestChallenge
- TestChallengeCommand
- TestChatCommand
- TestChessClock
- TestChessClockWithLeastZero
- TestChessClockWithLeastZeroFischer
- TestClientAtmark
- TestComment
- TestCompatibleArray
- TestConfig
- TestDeleteBuoyCommand
- TestDeleteMostPlayingPlayer
- TestDuplicatedMoves
- TestErrorCommand
- TestExceptionCommand
- TestExcludeSacrifice
- TestExcludeUnratedPlayers
- TestFactorial
- TestFactoryMethod
- TestFloodgate
- TestFloodgateGame
- TestFloodgateGameWrongTebam
- TestFloodgateHistory
- TestFork
- TestForkCommand
- TestFunctionalChatCommand
- TestGame
- TestGameCommand
- TestGameResult
- TestGameResult::DummyGame
- TestGameWithLeastZero
- TestGetBuoyCountCommand
- TestHandicappedGame
- TestHandicappedGameName
- TestHash
- TestHelpCommand
- TestHistory
- TestLeague
- TestLeastDiff
- TestLeastDiff::MockLeague
- TestLeastRatePlayer
- TestListCommand
- TestLogger
- TestLogin
- TestLoginCSAWithTripGoodGamename
- TestLoginCSAWithoutTripGoodGamename
- TestLogoutCommand
- TestMakeEven
- TestMkdir
- TestMonitor2OffCommand
- TestMonitor2OnCommand
- TestMonitorHandler
- TestMonitorHandler1
- TestMonitorHandler2
- TestMonitorOffCommand
- TestMonitorOnCommand
- TestMove
- TestMoveBack
- TestMoveCommand
- TestNextTimeGenerator
- TestNextTimeGeneratorConfig
- TestNextTimeGenerator_3600_0
- TestNextTimeGenerator_900_0
- TestPairing
- TestPersistent
- TestPlayer
- TestRandomize
- TestRatingCommand
- TestRejectCommand
- TestSetBuoyCommand
- TestSetupFloodgate
- TestShogiServer
- TestShowCommand
- TestSortByRate
- TestSortByRateWithRandomness
- TestSpaceCommand
- TestSpecialComand
- TestSplitMoves
- TestStartGame
- TestStartGameWithoutHumans
- TestStopWatchClock
- TestSwissPairing
- TestTimeClockFactor
- TestTwoSameMoves
- TestUsi
- TestVersionCommand
- TestWhiteMovesBlack
- TestWhoCommand
- TestWinLossMatrix
- Test_2fu
- Test_checkmate
- Test_gps
- Test_illegal
- Test_kachi
- Test_move
- Test_promote
- Test_put
- Test_sennichite
- Test_uchifuzume
- TestableLogger
- TestnCk