강동현

메세지에 설명 추가

...@@ -5,31 +5,58 @@ export interface Message { ...@@ -5,31 +5,58 @@ export interface Message {
5 readonly type: string; 5 readonly type: string;
6 } 6 }
7 7
8 +/**
9 + * 클라 -> 서버
10 + * 로그인 정보를 서버에게 전송합니다.
11 + */
8 export class LoginMessage implements Message { 12 export class LoginMessage implements Message {
9 readonly type = MessageType.LOGIN; 13 readonly type = MessageType.LOGIN;
10 constructor(public username: string) {} 14 constructor(public username: string) {}
11 } 15 }
12 16
17 +/**
18 + * 클라 <- 서버
19 + * 방 리스트를 서버에서 받아옵니다.
20 + */
13 export class RoomListMessage implements Message { 21 export class RoomListMessage implements Message {
14 readonly type = MessageType.ROOM_LIST; 22 readonly type = MessageType.ROOM_LIST;
15 constructor(public rooms: RoomData[]) {} 23 constructor(public rooms: RoomData[]) {}
16 } 24 }
17 25
26 +/**
27 + * 클라 -> 서버
28 + * 방에 접속합니다.
29 + */
18 export class RoomJoinMessage implements Message { 30 export class RoomJoinMessage implements Message {
19 readonly type = MessageType.ROOM_JOIN; 31 readonly type = MessageType.ROOM_JOIN;
20 constructor(public uuid: string) {} 32 constructor(public uuid: string) {}
21 } 33 }
22 34
35 +/**
36 + * 클라 -> 서버
37 + * 방에서 나갑니다.
38 + */
23 export class RoomLeaveMessage implements Message { 39 export class RoomLeaveMessage implements Message {
24 readonly type = MessageType.ROOM_LEAVE; 40 readonly type = MessageType.ROOM_LEAVE;
25 constructor() {} 41 constructor() {}
26 } 42 }
27 43
44 +/**
45 + * 클라 <- 서버
46 + * 방에 접속할 때, 방의 정보를 받아옵니다.
47 + * @param userdata 현재 방에 접속 중인 유저 목록입니다.
48 + */
28 export class RoomInfoMessage implements Message { 49 export class RoomInfoMessage implements Message {
29 readonly type = MessageType.ROOM_INFO; 50 readonly type = MessageType.ROOM_INFO;
30 constructor(public userdata: UserData[]) {} 51 constructor(public userdata: UserData[]) {}
31 } 52 }
32 53
54 +/**
55 + * 클라 <- 서버
56 + * 접속한 방에 새로운 유저가 들어오거나 나갈 때 전송됩니다.
57 + * @param state 유저가 입장하면 added, 퇴장하면 removed 값을 가집니다.
58 + * @param userdata 대상 유저입니다.
59 + */
33 export class RoomUserUpdateMessage implements Message { 60 export class RoomUserUpdateMessage implements Message {
34 readonly type = MessageType.ROOM_USER_UPDATE; 61 readonly type = MessageType.ROOM_USER_UPDATE;
35 constructor( 62 constructor(
......