Todo #88

UPC spec refinement: rename/revise "results" UPCs

Added by colin moock 703 days ago. Updated 364 days ago.

Status :Closed Start :09/30/2008
Priority :Normal Due date :
Assigned to :- % Done :

0%
Category :UPC
Target version :Union 1.0 Alpha 4

Description

Some UPC messages named with the "_RESULT" convention are not actually always results. For example, u44 might be sent when the server forces a client to leave a room (not as the result of a client request to leave a room). The UPC specification should be scrubbed for these anomalies.

Resolution:

Where a request triggers an action and also has a result, define two different UPC messages, one for the action and one for the result. For example, JOINED_ROOM (the action) and JOIN_ROOM_RESULTS (the result). The action is sent to all affected clients, and might be triggered entirely server side. The result is sent to the client that made the initial request only.

Implementation

The following UPCs will be updated as follows:

  • u6
    -> change u6 to JOINED_ROOM
    -> add new upc: JOIN_ROOM_RESULT
  • u8
    -> change u8 to CLIENT_ATTR_UPDATE
    -> add new upc: SET_CLIENT_ATTR_RESULT
  • u9
    -> change u9 to ROOM_ATTR_UPDATE
    -> add new upc: SET_ROOM_ATTR_RESULT
  • u34
    -> change u34 to NUM_CLIENTS_UPDATE
    -> add new upc: GET_NUM_CLIENTS_RESULT
  • u38
    -> rename to ROOM_LIST_UPDATE
  • u44
    -> change u44 to LEFT_ROOM
    -> add new upc: LEAVE_ROOM_RESULT
  • u50
    -> change u50 to SERVER_TIME_UPDATE
  • u59
    -> change u59 to OBSERVED_ROOM
    -> add new upc: OBSERVE_ROOM_RESULT
  • u62
    -> change u62 to STOPPED_OBSERVING_ROOM
    -> add new upc: OBSERVE_ROOM_RESULT
  • u69
    -> add new upc: ROOM_ATTR_REMOVED
    -> add new upc: REMOVE_ROOM_ATTR_RESULT
  • u69
    -> add new upc: CLIENT_ATTR_REMOVED
    -> add new upc: REMOVE_CLIENT_ATTR_RESULT

History

05/01/2009 08:09 PM - derek clayton

  • Target version set to Union Server 1.0 Alpha 2

05/12/2009 12:03 AM - derek clayton

  • Target version changed from Union Server 1.0 Alpha 2 to Union Server 1.0 Alpha 3

05/12/2009 12:28 AM - colin moock

  • Subject changed from does server-initiated room-leave trigger u44? to UPC spec refinement: rename/revise "results" UPCs

07/27/2009 07:13 PM - derek clayton

  • Target version set to Union 1.0 Alpha 3

07/30/2009 02:09 PM - colin moock

  • Category set to UPC

07/30/2009 07:13 PM - colin moock

  • Target version changed from Union 1.0 Alpha 3 to Union 1.0 Alpha 4

09/03/2009 05:56 PM - colin moock

  • Status changed from New to Closed

Also available in: Atom