Miroirs/xwords
1
0
Fork 0
mirror of git://xwords.git.sourceforge.net/gitroot/xwords/xwords synced 2024-12-27 09:58:45 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
xwords/xwords4/relay/states.cpp
Andy2 30145deba7 add new proxy message handler for no-conn message, and feed into 
existing store-and-forward system.  With this checkin a robot-vs-robot
game plays for quite a few moves without either game every loaded into
the foreground (via a BoardActivity instance on Android), with all
moves transmitted as a result of relay checks.  One of the games
refuses to open later, however, and there are certainly other bugs.
And I'm not sure what happens when a message sent no-conn (without a
cookie ID) is received in the foreground.  But this is progress.
2011-08-16 19:41:33 -07:00

295 lines
11 KiB
C++
Raw Permalink Blame History

/* -*-mode: C; fill-column: 78; c-basic-offset: 4; -*- */
/*
* Copyright 2005-2011 by Eric House (xwords@eehouse.org). All rights
* reserved.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#include "assert.h"
#include "string.h"
#include "states.h"
#include "xwrelay_priv.h"
typedef struct StateTable {
XW_RELAY_STATE stateStart;
XW_RELAY_EVENT stateEvent;
XW_RELAY_ACTION stateAction;
XW_RELAY_STATE stateEnd; /* Do I need this? Or does the code that
performs the action determine the state? */
} StateTable;
/* Connecting. The problem is that we don't know how many devices to expect.
So hosts connect and get a response. Hosts send messages to be forwarded.
We may or may not have an ID for the recipient host. If we do, we forward.
If we don't, we drop. No big deal. So is there any difference between
CONNECTING and CONNECTED? I don't think so. Messages come in and we try
to forward. Connection requests come in and we accept them if the host in
question is unknown. NOT QUITE. There's a DOS vulnerability there. It's
best if we can put the game in a state where others can't connect, if the
window where new devices can sign in using a given cookie is fairly small.
New rules on accepting connections and reconnections:
- Connect messages contain nPlayersHere (local) and nPlayersTotal params.
- On connect action, we either note the total expected, or increase the
total we have. Ditto on reconnect. On disconnect, we take the departing
hosts marbles away from the game.
- We only accept [re]connections when we're missing players, and we only
forward messages when all devices/players are accounted for. There's a
notification sent when the last shows up, so devices can send pending
messages at that time.
- There's at least one bug with this scheme: we don't know how many players
to expect until the server shows up, so we'll keep accepting clients
until that happens. Probably need a config variable that sets an upper
bound on the number of players.
*/
static StateTable g_stateTable[] = {
{ XWS_EMPTY, XWE_DEVCONNECT, XWA_SEND_CONNRSP, XWS_WAITMORE },
{ XWS_WAITMORE, XWE_DEVCONNECT, XWA_SEND_CONNRSP, XWS_WAITMORE },
{ XWS_WAITMORE, XWE_GOTONEACK, XWA_NOTEACK, XWS_WAITMORE },
{ XWS_WAITMORE, XWE_ACKTIMEOUT, XWA_DROPDEVICE, XWS_WAITMORE },
{ XWS_WAITMORE, XWE_ALLHERE, XWA_SENDALLHERE, XWS_ALLCONND },
{ XWS_WAITMORE, XWE_RECONNECT, XWA_SEND_RERSP, XWS_WAITMORE },
{ XWS_WAITMORE, XWE_FORWARDMSG, XWA_FWD, XWS_WAITMORE },
{ XWS_ALLCONND, XWE_RECONNECT, XWA_SEND_RERSP, XWS_ALLCONND },
{ XWS_ALLCONND, XWE_ALLHERE, XWA_NONE, XWS_ALLCONND },
{ XWS_ALLCONND, XWE_REMOVESOCKET, XWA_REMOVESOCK_1, XWS_ALLCONND },
{ XWS_ALLCONND, XWE_GOTONEACK, XWA_NONE, XWS_ALLCONND },
{ XWS_EMPTY, XWE_PROXYMSG, XWA_PROXYMSG, XWS_SAME },
{ XWS_ALLCONND, XWE_PROXYMSG, XWA_PROXYMSG, XWS_SAME },
/* { XWS_WAITMORE, XWE_GAMEFULL, XWA_SENDALLHERE, XWS_ALLCONND }, */
/* { XWS_WAITMORE, XWE_CHECKFULL, XWA_, XWS_WAITMORE }, */
/* { XWS_INITED, XWE_DEVCONNECT, XWA_SEND_NO_ROOM, XWS_DEAD }, */
/* { XWS_WAITMORE, XWE_DEVCONNECT, XWA_CHECK_FULL, XWS_FULLCHK }, */
/* { XWS_FULLCHK, XWE_FULLCHK */
/* { XWS_ROOMCHK, XWE_HAVE_ROOM, XWA_SEND_GUEST_RSP, XWS_CHK_ALLHERE }, */
/* { XWS_ROOMCHK, XWE_TOO_MANY, XWA_SEND_TOO_MANY, XWS_WAITGUESTS }, */
/* { XWS_CHK_ALLHERE, XWE_ALLHERE, XWA_SENDALLHERE, XWS_ALLCONND }, */
/* { XWS_ALLCONND, XWE_SOMEMISSING, XWA_NONE, XWS_ALLCONND }, */
{ XWS_ALLCONND, XWE_ALLGONE, XWA_NONE, XWS_ALLCONND },
/* { XWS_CHK_ALLHERE, XWE_SOMEMISSING, XWA_NONE, XWS_WAITMORE }, */
{ XWS_ALLCONND, XWE_DISCONN, XWA_DISCONNECT, XWS_WAITMORE },
{ XWS_WAITMORE, XWE_DISCONN, XWA_DISCONNECT, XWS_WAITMORE },
/* EMPTY means have messages to send but no connections. Time out and free
memory after a while. BUT: don't I really want to keep these forever and
free the oldest ones if memory usage realy does become a problem.
There's no problem now! */
/* { XWS_WAITMORE, XWE_NOMORESOCKETS, XWA_NONE, XWS_WAITMORE }, */
/* { XWS_MISSING, XWE_NOMORESOCKETS, XWA_NOTE_EMPTY, XWS_MSGONLY }, */
/* { XWS_MSGONLY, XWE_NOMOREMSGS, XWA_NONE, XWS_DEAD }, */
/* { XWS_MSGONLY, XWE_NOMOREMSGS, XWA_NONE, XWS_DEAD }, */
{ XWS_ANY, XWE_NOMORESOCKETS, XWA_NONE, XWS_EMPTY },
{ XWS_ANY, XWE_SHUTDOWN, XWA_SHUTDOWN, XWS_EMPTY },
/* drop timeout (unless we're in XWS_WAITMORE; see above) */
{ XWS_ANY, XWE_ACKTIMEOUT, XWA_NONE, XWS_SAME },
/* This doesn't make sense. Can't go straight to ALLCOND if don't have all
players/devices. */
{ XWS_EMPTY, XWE_RECONNECT, XWA_SEND_RERSP, XWS_WAITMORE },
{ XWS_MSGONLY, XWE_RECONNECT, XWA_SEND_RERSP, XWS_WAITMORE },
/* { XWS_MISSING, XWE_RECONNECT, XWA_SEND_RERSP, XWS_CHK_ALLHERE_2 }, */
/* { XWS_CHK_ALLHERE_2, XWE_ALLHERE, XWA_SNDALLHERE_2, XWS_ALLCONND }, */
/* { XWS_CHK_ALLHERE_2, XWE_SOMEMISSING, XWA_NONE, XWS_MISSING }, */
{ XWS_WAITMORE, XWE_REMOVESOCKET, XWA_REMOVESOCK_1, XWS_WAITMORE },
/* { XWS_ALLCONND, XWE_REMOVESOCKET, XWA_REMOVESOCK_2, XWS_MISSING }, */
/* { XWS_MISSING, XWE_REMOVESOCKET, XWA_REMOVESOCK_2, XWS_MISSING }, */
#ifdef RELAY_HEARTBEAT
{ XWS_ALLCONND, XWE_HEARTFAILED, XWA_HEARTDISCONN, XWS_MISSING },
{ XWS_WAITMORE, XWE_HEARTFAILED, XWA_HEARTDISCONN, XWS_WAITMORE },
{ XWS_MISSING, XWE_HEARTFAILED, XWA_HEARTDISCONN, XWS_MISSING },
/* Heartbeat arrived */
{ XWS_WAITMORE, XWE_HEARTRCVD, XWA_NOTEHEART, XWS_WAITMORE },
{ XWS_ALLCONND, XWE_HEARTRCVD, XWA_NOTEHEART, XWS_ALLCONND },
{ XWS_MISSING, XWE_HEARTRCVD, XWA_NOTEHEART, XWS_MISSING },
#endif
{ XWS_EMPTY, XWE_DEVGONE, XWA_RMDEV, XWS_EMPTY },
{ XWS_WAITMORE, XWE_DEVGONE, XWA_RMDEV, XWS_WAITMORE },
/* This should be impossible unless device allows deleting an open/connected
game */
{ XWS_ALLCONND, XWE_DEVGONE, XWA_RMDEV, XWS_WAITMORE },
{ XWS_WAITMORE, XWE_GAMEDEAD, XWA_TELLGAMEDEAD, XWS_WAITMORE },
{ XWS_ALLCONND, XWE_GAMEDEAD, XWA_TELLGAMEDEAD, XWS_ALLCONND },
/* Connect timer */
{ XWS_WAITMORE, XWE_CONNTIMER, XWA_TIMERDISCONN, XWS_EMPTY },
/* { XWS_MISSING, XWE_CONNTIMER, XWA_NONE, XWS_MISSING }, */
{ XWS_ALLCONND, XWE_CONNTIMER, XWA_NONE, XWS_ALLCONND },
{ XWS_WAITMORE, XWE_NOTIFYDISCON, XWA_NOTIFYDISCON, XWS_WAITMORE },
/* { XWS_ALLCONND, XWE_NOTIFYDISCON, XWA_NOTIFYDISCON, XWS_MISSING }, */
/* { XWS_MISSING, XWE_NOTIFYDISCON, XWA_NOTIFYDISCON, XWS_MISSING }, */
{ XWS_EMPTY, XWE_NOTIFYDISCON, XWA_NOTIFYDISCON, XWS_EMPTY },
/* This is our bread-n-butter */
{ XWS_ALLCONND, XWE_FORWARDMSG, XWA_FWD, XWS_ALLCONND },
/* { XWS_MISSING, XWE_FORWARDMSG, XWA_FWD, XWS_MISSING }, */
{ XWS_EMPTY, XWE_REMOVESOCKET, XWA_REMOVESOCK_1, XWS_EMPTY }
};
bool
getFromTable( XW_RELAY_STATE curState, XW_RELAY_EVENT curEvent,
XW_RELAY_ACTION* takeAction, XW_RELAY_STATE* nextState )
{
bool found = false;
StateTable* stp = g_stateTable;
const StateTable* end = stp + sizeof(g_stateTable)/sizeof(g_stateTable[0]);
while ( stp < end ) {
if ( stp->stateStart == curState || stp->stateStart == XWS_ANY ) {
if ( stp->stateEvent == curEvent || stp->stateEvent == XWE_ANY ) {
*takeAction = stp->stateAction;
*nextState =
stp->stateEnd == XWS_SAME? curState : stp->stateEnd;
found = true;
break;
}
}
++stp;
}
return found;
} /* getFromTable */
#define CASESTR(s) case s: str = #s; break
const char*
stateString( XW_RELAY_STATE state )
{
const char* str = NULL;
switch( state ) {
CASESTR(XWS_NONE);
CASESTR(XWS_ANY);
CASESTR(XWS_EMPTY);
CASESTR(XWS_WAITMORE);
CASESTR(XWS_WAITING_ACKS);
CASESTR(XWS_ALLCONND);
/* CASESTR(XWS_MISSING); */
CASESTR(XWS_MSGONLY);
/* CASESTR(XWS_CHK_ALLHERE); */
/* CASESTR(XWS_CHK_ALLHERE_2); */
/* CASESTR(XWS_CHKCOUNTS_INIT); */
/* CASESTR(XWS_ROOMCHK); */
default:
assert(0);
}
assert( 0 == strncmp( "XWS_", str, 4 ) );
str += 4;
return str;
}
const char*
eventString( XW_RELAY_EVENT evt )
{
const char* str = NULL;
switch( evt ) {
CASESTR(XWE_NONE);
CASESTR(XWE_DEVCONNECT);
CASESTR(XWE_RECONNECT);
CASESTR(XWE_GOTONEACK);
CASESTR(XWE_PROXYMSG);
CASESTR(XWE_GOTLASTACK);
CASESTR(XWE_ACKTIMEOUT);
CASESTR(XWE_DISCONN);
CASESTR(XWE_DEVGONE);
CASESTR(XWE_GAMEDEAD);
CASESTR(XWE_FORWARDMSG);
#ifdef RELAY_HEARTBEAT
CASESTR(XWE_HEARTRCVD);
CASESTR(XWE_HEARTFAILED);
#endif
CASESTR(XWE_CONNTIMER);
CASESTR(XWE_ANY);
CASESTR(XWE_REMOVESOCKET);
CASESTR(XWE_NOMORESOCKETS);
CASESTR(XWE_NOMOREMSGS);
CASESTR(XWE_NOTIFYDISCON);
CASESTR(XWE_ALLHERE);
/* CASESTR(XWE_SOMEMISSING); */
/* CASESTR(XWE_TOO_MANY); */
/* CASESTR(XWE_HAVE_ROOM); */
CASESTR(XWE_SHUTDOWN);
default:
assert(0);
}
return str;
}
const char*
actString( XW_RELAY_ACTION act )
{
const char* str = NULL;
switch ( act ) {
CASESTR(XWA_NONE);
CASESTR(XWA_SEND_RERSP);
CASESTR(XWA_SENDALLHERE);
CASESTR(XWA_SEND_NO_ROOM);
CASESTR(XWA_SEND_TOO_MANY);
CASESTR(XWA_SEND_DUP_ROOM);
CASESTR(XWA_SEND_INITRSP);
CASESTR(XWA_SEND_CONNRSP);
CASESTR(XWA_NOTEACK);
/* CASESTR(XWA_ADDDEVICE); */
CASESTR(XWA_DROPDEVICE);
CASESTR(XWA_SNDALLHERE_2);
CASESTR(XWA_FWD);
CASESTR(XWA_PROXYMSG);
CASESTR(XWA_NOTEHEART);
CASESTR(XWA_TIMERDISCONN);
CASESTR(XWA_DISCONNECT);
CASESTR(XWA_RMDEV);
CASESTR(XWA_TELLGAMEDEAD);
CASESTR(XWA_NOTIFYDISCON);
CASESTR(XWA_REMOVESOCK_1);
CASESTR(XWA_REMOVESOCK_2);
CASESTR(XWA_HEARTDISCONN);
CASESTR(XWA_SHUTDOWN);
CASESTR(XWA_CHECK_HAVE_ROOM);
CASESTR(XWA_NOTE_EMPTY);
default:
assert(0);
}
return str;
}
#undef CASESTR
Reference in a new issue View git blame Copy permalink