diff --git a/src/client_container.proto b/src/client_container.proto index c2775c784..ee07cb37a 100644 --- a/src/client_container.proto +++ b/src/client_container.proto @@ -11,11 +11,11 @@ message ClientMessage { enum Type { LOGIN = 100; LOGIN_ACK = 101; - LOGIN_JAM_SESSION = 102; - LOGIN_JAM_SESSION_ACK = 103; - USER_JOINED_JAM_SESSION = 104; - LEAVE_JAM_SESSION = 105; - LEAVE_JAM_SESSION_ACK = 106; + LOGIN_MUSIC_SESSION = 102; + LOGIN_MUSIC_SESSION_ACK = 103; + USER_JOINED_MUSIC_SESSION = 104; + LEAVE_MUSIC_SESSION = 105; + LEAVE_MUSIC_SESSION_ACK = 106; HEARTBEAT = 107; TEST_SESSION_MESSAGE = 200; @@ -33,11 +33,11 @@ message ClientMessage { // Client-Server messages (to/from) optional Login login = 100; // to server optional LoginAck login_ack = 101; // from server - optional LoginJamSession login_jam_session = 102; // to server - optional LoginJamSessionAck login_jam_session_ack = 103; // from server - optional UserJoinedJamSession user_joined_jam_session = 104; // from server to all members - optional LeaveJamSession leave_jam_session = 105; - optional LeaveJamSessionAck leave_jam_session_ack = 106; + optional LoginMusicSession login_music_session = 102; // to server + optional LoginMusicSessionAck login_music_session_ack = 103; // from server + optional UserJoinedMusicSession user_joined_music_session = 104; // from server to all members + optional LeaveMusicSession leave_music_session = 105; + optional LeaveMusicSessionAck leave_music_session_ack = 106; optional Heartbeat heartbeat = 107; // Client-Session messages (to/from) @@ -56,7 +56,7 @@ message ClientMessage { message Login { optional string username = 1; // username... could be email. need to wait for prod requirements optional string password = 2; // a password - optional string token = 3; // a token/cookie from previous successful login attempt or from 'token' field in .jam file + optional string token = 3; // a token/cookie from previous successful login attempt or from 'token' field in .music file } // target: client @@ -67,31 +67,31 @@ message LoginAck { } // target: server -// send from client to server to log in to a jam session and be 'present'. -// if successful, a LoginJamSessionAck is sent with error = false, and Client-Session messages will be passed -// directly from client to all other client. Also, the server will generate a 'UserJoinedJamSession' message +// send from client to server to log in to a music session and be 'present'. +// if successful, a LoginMusicSessionAck is sent with error = false, and Client-Session messages will be passed +// directly from client to all other client. Also, the server will generate a 'UserJoinedMusicSession' message // and send it to all other users to let the others know the user is here. -// if errored, a LoginJamSessionAck is sent with error = true. -message LoginJamSession { - optional string jam_session = 1; +// if errored, a LoginMusicSessionAck is sent with error = true. +message LoginMusicSession { + optional string music_session = 1; } // target: client -// error = true if the LoginJamSession command failed. -message LoginJamSessionAck { +// error = true if the LoginMusicSession command failed. +message LoginMusicSessionAck { optional bool error = 1; optional string error_reason = 2; } // target: server -// send from client to server to leave a previously joined jam session -message LeaveJamSession { - optional string jam_session = 1; +// send from client to server to leave a previously joined music session +message LeaveMusicSession { + optional string music_session = 1; } // target: client // error = true if the session didn't exist, but otherwise this is intended to always work barring server unrecoverable errors -message LeaveJamSessionAck { +message LeaveMusicSessionAck { optional bool error = 1; optional string error_reason = 2; } @@ -99,7 +99,7 @@ message LeaveJamSessionAck { // target: client: // sent by server to let the rest of the participants know a user has joined. // this feels a little off; client could initiate this to other clients, right? -message UserJoinedJamSession { +message UserJoinedMusicSession { optional string user_id = 1; // this is the user_id and can be used for user unicast messages optional string username = 2; // meant to be a display name }