> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Realtime API リファレンス

リアルタイム通信機能




対戦・協力プレイ機能を実現します。

ルームを作成すると、`IPアドレス` `ポート` `暗号鍵` の3つの情報が発行されます。<br>
ルームに参加するには、発行された `IPアドレス` `ポート` に WebSocket で接続します。<br>
その通信には発行された `暗号鍵` を使用して通信します。

一般的な GS2 のサービスは API リクエスト回数に対して料金が発生しますが、<br>
このサービスはゲームサーバーの起動時間と通信容量に対して費用が発生し、<br>
通信回数に対しては費用が発生しません。

### ルームのライフサイクル

#### 作成

GS2-Realtime はルームの作成リクエストを受け付けてからサーバを起動します。<br>
この時、割り当て可能な空きルームが一定数を下回っていた場合、<br>
ホットスタンバイとなるルームをまとめて追加で起動します。

つまり、リクエストを受け付けてからサーバを起動する `コールドスタート` 時と ホットスタンバイされたルームを利用する `ウォームスタート` でルームの作成リクエストを受け付けてから実際に割り当てられるまでの時間に差が生じます。

コールドスタート時の待ち時間の目安は 40秒〜60秒<br>
ウォームスタート時の待ち時間の目安は1秒〜3秒です。

#### 終了

起動されたルームは作成後5分間誰も接続に来なかった場合終了されます。<br>
この終了処理はホットスタンバイのルームにも適用されますが、ホットスタンバイの起動時間は利用料金に加算されません。

ルームに参加するすべてのプレイヤーから無通信状態が1分間続いても自動的に終了されます。

ルームの最大起動時間は3時間です。作成から3時間が経過すると自動的に終了されます。

#### コールドスタートの発生条件

- ホットスタンバイを用意するより早くサーバーの起動リクエストを出した場合
- ゲームサーバーのバージョンアップが行われた場合
- 起動リクエストが頻繁に発生しない規模のため、ホットスタンバイが用意されていない場合

[マイクロサービス紹介 / GS2-Realtime](../../microservices/realtime)



- [GS2-Realtime Deploy/CDK リファレンス](/ja/api_reference/realtime/deploy/)
  
- [GS2-Realtime SDK API リファレンス](/ja/api_reference/realtime/sdk/)
  
- [GS2-Realtime SDK for Game Engine API リファレンス](/ja/api_reference/realtime/game_engine/)