Presently, the lobby registry is configured with lobbies via the * server configuration. An example configuration follows: * *
* lobby_ids = foolobby, barlobby, bazlobby * * foolobby.mgrclass = com.threerings.micasa.lobby.LobbyManager * foolobby.ugi =* * This information will be loaded from the MiCasa server configuration * which means that it should live in ** foolobby.name = * foolobby.config1 = some config value * foolobby.config2 = some other config value * * barlobby.mgrclass = com.threerings.micasa.lobby.LobbyManager * barlobby.ugi = * barlobby.name = * ... *
rsrc/config/micasa/server.properties somwhere in the
* classpath where it will override the default MiCasa server properties
* file.
*
* The UGI or universal game identifier is a string that
* is used to uniquely identify every type of game and also to classify it
* according to meaningful keywords. It is best described with a few
* examples:
*
*
* backgammon,board,strategy * spades,card,partner * yahtzee,dice ** * As you can see, a UGI should start with an identifier uniquely * identifying the type of game and can be followed by a list of keywords * that classify it as a member of a particular category of games * (eg. board, card, dice, partner game, strategy game). A game can belong * to multiple categories. * *
As long as the UGIs in use by a particular server make some kind of * sense, the client will be able to use them to search for lobbies * containing games of similar types using the provided facilities. */ public class LobbyRegistry implements LobbyProvider { /** * Initializes the registry. It will use the supplied configuration * instance to determine which lobbies to load, etc. * * @param invmgr a reference to the server's invocation manager. */ public void init (InvocationManager invmgr) { // register ourselves as an invocation service handler invmgr.registerDispatcher(new LobbyDispatcher(this), true); // create our lobby managers String[] lmgrs = null; lmgrs = MiCasaConfig.config.getValue(LOBIDS_KEY, lmgrs); if (lmgrs == null || lmgrs.length == 0) { Log.warning("No lobbies specified in config file (via '" + LOBIDS_KEY + "' parameter)."); } else { for (int i = 0; i < lmgrs.length; i++) { loadLobby(lmgrs[i]); } } } /** * Returns the oid of the default lobby. */ public int getDefaultLobbyOid () { return _defLobbyOid; } /** * Extracts the properties for a lobby from the server config and * creates and initializes the lobby manager. */ protected void loadLobby (String lobbyId) { try { // extract the properties for this lobby Properties props = MiCasaConfig.config.getSubProperties(lobbyId); // get the lobby manager class and UGI String cfgClass = props.getProperty("config"); if (StringUtil.isBlank(cfgClass)) { throw new Exception("Missing 'config' definition in " + "lobby configuration."); } // create and initialize the lobby config object LobbyConfig config = (LobbyConfig) Class.forName(cfgClass).newInstance(); config.init(props); // create and initialize the lobby manager. it will call // lobbyReady() when it has obtained a reference to its lobby // object and is ready to roll LobbyManager lobmgr = (LobbyManager) MiCasaServer.plreg.createPlace(config, null); lobmgr.init(this, props); } catch (Exception e) { Log.warning("Unable to create lobby manager " + "[lobbyId=" + lobbyId + ", error=" + e + "]."); } } /** * Returns information about all lobbies hosting games in the * specified category. * * @param requester the body object of the client requesting the lobby * list (which can be used to filter the list based on their * capabilities). * @param category the category of game for which the lobbies are * desired. * @param target the list into which the matching lobbies will be * deposited. */ public void getLobbies (BodyObject requester, String category, List target) { ArrayList list = (ArrayList)_lobbies.get(category); if (list != null) { target.addAll(list); } } /** * Returns an array containing the category identifiers of all the * categories in which lobbies have been registered with the registry. * * @param requester the body object of the client requesting the * cateogory list (which can be used to filter the list based on their * capabilities). */ public String[] getCategories (BodyObject requester) { // might want to cache this some day so that we don't recreate it // every time someone wants it. we can cache the array until the // category count changes String[] cats = new String[_lobbies.size()]; Iterator iter = _lobbies.keySet().iterator(); for (int i = 0; iter.hasNext(); i++) { cats[i] = (String)iter.next(); } return cats; } /** * Processes a request by the client to obtain a list of the lobby * categories available on this server. */ public void getCategories (ClientObject caller, CategoriesListener listener) { listener.gotCategories(getCategories((BodyObject)caller)); } /** * Processes a request by the client to obtain a list of lobbies * matching the supplied category string. */ public void getLobbies (ClientObject caller, String category, LobbiesListener listener) { StreamableArrayList target = new StreamableArrayList(); ArrayList list = (ArrayList)_lobbies.get(category); if (list != null) { target.addAll(list); } listener.gotLobbies(target); } /** * Called by our lobby managers once they have started up and are * ready to do their lobby duties. */ protected void lobbyReady (int placeOid, String gameIdent, String name) { // create a lobby record Lobby record = new Lobby(placeOid, gameIdent, name); // if we don't already have a default lobby, this one is the big // winner if (_defLobbyOid == -1) { _defLobbyOid = placeOid; } // and register it in all the right lobby tables StringTokenizer tok = new StringTokenizer(gameIdent, ","); while (tok.hasMoreTokens()) { String category = tok.nextToken(); registerLobby(category, record); } } /** Registers the supplied lobby in the specified category table. */ protected void registerLobby (String category, Lobby record) { ArrayList catlist = (ArrayList)_lobbies.get(category); if (catlist == null) { catlist = new ArrayList(); _lobbies.put(category, catlist); } catlist.add(record); Log.info("Registered lobby [cat=" + category + ", record=" + record + "]."); } /** A table containing references to all of our lobby records (in the * form of category lists. */ protected HashMap _lobbies = new HashMap(); /** The oid of the default lobby. */ protected int _defLobbyOid = -1; /** The configuration key for the lobby managers list. */ protected static final String LOBIDS_KEY = "lobby_ids"; }