> 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 레퍼런스](/ko/api_reference/realtime/deploy/)
  
- [GS2-Realtime SDK API 레퍼런스](/ko/api_reference/realtime/sdk/)
  
- [GS2-Realtime SDK for Game Engine API 레퍼런스](/ko/api_reference/realtime/game_engine/)