mirror of
git://xwords.git.sourceforge.net/gitroot/xwords/xwords
synced 2025-01-03 23:04:08 +01:00
f2c4c82129
Ideally the comms module wouldn't go through its connecting routine in order to join a game. To that end I added a join() method to relay.py and code to call it. Joins happen (pairing games, starting new ones, etc.), but after that communication doesn't. First part of fixing that would be to make cookieID persistent and transmit it back with the rest of what join sends (since it's used by all the messages currently sent in a connected state), but I suspect there's more to be done, and even that requires a fair number of changes on the relay side. So all that's wrapped in #ifdef RELAY_VIA_HTTP (and turned off.)
295 lines
9.9 KiB
C
295 lines
9.9 KiB
C
/* -*- compile-command: "cd ../linux && make MEMDEBUG=TRUE -j3"; -*- */
|
|
/*
|
|
* Copyright 2001 - 2014 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.
|
|
*/
|
|
|
|
#ifndef _COMMS_H_
|
|
#define _COMMS_H_
|
|
|
|
#include "comtypes.h"
|
|
#include "mempool.h"
|
|
#include "xwrelay.h"
|
|
#include "server.h"
|
|
|
|
EXTERN_C_START
|
|
|
|
#define CHANNEL_NONE ((XP_PlayerAddr)0)
|
|
#define CONN_ID_NONE 0L
|
|
|
|
typedef XP_U32 MsgID; /* this is too big!!! PENDING */
|
|
typedef XP_U8 XWHostID;
|
|
|
|
typedef enum {
|
|
COMMS_CONN_NONE /* I want errors on uninited case */
|
|
,COMMS_CONN_IR
|
|
,COMMS_CONN_IP_DIRECT
|
|
,COMMS_CONN_RELAY
|
|
,COMMS_CONN_BT
|
|
,COMMS_CONN_SMS
|
|
,COMMS_CONN_P2P /* a.k.a. Wifi direct */
|
|
|
|
,COMMS_CONN_NTYPES
|
|
} CommsConnType;
|
|
|
|
typedef XP_U8 CommsConnTypes;
|
|
|
|
typedef enum {
|
|
COMMS_RELAYSTATE_UNCONNECTED
|
|
, COMMS_RELAYSTATE_DENIED /* terminal; new game or reset required to
|
|
fix */
|
|
, COMMS_RELAYSTATE_CONNECT_PENDING
|
|
, COMMS_RELAYSTATE_CONNECTED
|
|
, COMMS_RELAYSTATE_RECONNECTED
|
|
, COMMS_RELAYSTATE_ALLCONNECTED
|
|
#ifdef RELAY_VIA_HTTP
|
|
, COMMS_RELAYSTATE_USING_HTTP /* connection state doesn't matter */
|
|
#endif
|
|
} CommsRelayState;
|
|
|
|
#ifdef XWFEATURE_BLUETOOTH
|
|
# define XW_BT_UUID "7be0d084-ff89-4d6d-9c78-594773a6f963"
|
|
# define XW_BT_UUID_DBG "b079b640-35fe-11e5-a432-0002a5d5c51b"
|
|
|
|
# define XW_BT_NAME "Crosswords"
|
|
#endif
|
|
|
|
/* on Palm BtLibDeviceAddressType is a 48-bit quantity. Linux's typeis the
|
|
same size. Goal is something all platforms support */
|
|
typedef struct XP_BtAddr { XP_U8 bits[6]; } XP_BtAddr;
|
|
typedef struct XP_BtAddrStr { XP_UCHAR chars[18]; } XP_BtAddrStr;
|
|
|
|
#ifdef COMMS_HEARTBEAT
|
|
# define IF_CH(a) a,
|
|
#else
|
|
# define IF_CH(a)
|
|
#endif
|
|
|
|
#define MAX_HOSTNAME_LEN 63
|
|
#define MAX_PHONE_LEN 31
|
|
#define MAX_P2P_MAC_LEN 17
|
|
|
|
typedef struct _CommsAddrRec {
|
|
XP_U16 _conTypes;
|
|
|
|
struct {
|
|
struct {
|
|
XP_UCHAR hostName_ip[MAX_HOSTNAME_LEN + 1];
|
|
XP_U32 ipAddr_ip; /* looked up from above */
|
|
XP_U16 port_ip;
|
|
} ip;
|
|
struct {
|
|
XP_UCHAR invite[MAX_INVITE_LEN + 1]; /* room!!!! */
|
|
XP_UCHAR hostName[MAX_HOSTNAME_LEN + 1];
|
|
XP_U32 ipAddr; /* looked up from above */
|
|
XP_U16 port;
|
|
XP_Bool seeksPublicRoom;
|
|
XP_Bool advertiseRoom;
|
|
} ip_relay;
|
|
struct {
|
|
/* nothing? */
|
|
XP_UCHAR foo; /* wince doesn't like nothing here */
|
|
} ir;
|
|
struct {
|
|
/* guests can browse for the host to connect to */
|
|
XP_UCHAR hostName[MAX_HOSTNAME_LEN + 1];
|
|
XP_BtAddrStr btAddr;
|
|
} bt;
|
|
struct {
|
|
XP_UCHAR phone[MAX_PHONE_LEN + 1];
|
|
XP_U16 port;
|
|
} sms;
|
|
struct {
|
|
XP_UCHAR mac_addr[MAX_P2P_MAC_LEN + 1];
|
|
} p2p;
|
|
} u;
|
|
} CommsAddrRec;
|
|
|
|
typedef XP_S16 (*TransportSend)( const XP_U8* buf, XP_U16 len,
|
|
const XP_UCHAR* msgNo,
|
|
const CommsAddrRec* addr,
|
|
CommsConnType conType,
|
|
XP_U32 gameID, void* closure );
|
|
#ifdef COMMS_HEARTBEAT
|
|
typedef void (*TransportReset)( void* closure );
|
|
#endif
|
|
|
|
#ifdef XWFEATURE_RELAY
|
|
typedef void (*RelayStatusProc)( void* closure, CommsRelayState newState );
|
|
typedef void (*RelayConndProc)( void* closure, XP_UCHAR* const room,
|
|
XP_Bool reconnect,
|
|
XP_U16 devOrder, /* 1 means created room, etc. */
|
|
XP_Bool allHere, XP_U16 nMissing );
|
|
typedef void (*RelayErrorProc)( void* closure, XWREASON relayErr );
|
|
typedef XP_Bool (*RelayNoConnProc)( const XP_U8* buf, XP_U16 len,
|
|
const XP_UCHAR* msgNo,
|
|
const XP_UCHAR* relayID, void* closure );
|
|
# ifdef RELAY_VIA_HTTP
|
|
typedef void (*RelayRequestJoinProc)( void* closure, const XP_UCHAR* devID,
|
|
const XP_UCHAR* room, XP_U16 nPlayersHere,
|
|
XP_U16 nPlayersTotal, XP_U16 seed,
|
|
XP_U16 lang );
|
|
# endif
|
|
#endif
|
|
|
|
typedef enum {
|
|
COMMS_XPORT_FLAGS_NONE = 0
|
|
,COMMS_XPORT_FLAGS_HASNOCONN = 1
|
|
} CommsTransportFlags;
|
|
|
|
#ifdef COMMS_XPORT_FLAGSPROC
|
|
typedef XP_U32 (*FlagsProc)( void* closure );
|
|
#endif
|
|
|
|
typedef struct _TransportProcs {
|
|
# ifdef COMMS_XPORT_FLAGSPROC
|
|
FlagsProc getFlags;
|
|
#else
|
|
XP_U32 flags;
|
|
#endif
|
|
TransportSend send;
|
|
#ifdef COMMS_HEARTBEAT
|
|
TransportReset reset;
|
|
#endif
|
|
#ifdef XWFEATURE_RELAY
|
|
RelayStatusProc rstatus;
|
|
RelayConndProc rconnd;
|
|
RelayErrorProc rerror;
|
|
RelayNoConnProc sendNoConn;
|
|
# ifdef RELAY_VIA_HTTP
|
|
RelayRequestJoinProc requestJoin;
|
|
# endif
|
|
#endif
|
|
void* closure;
|
|
} TransportProcs;
|
|
|
|
CommsCtxt* comms_make( MPFORMAL XW_UtilCtxt* util,
|
|
XP_Bool isServer,
|
|
XP_U16 nPlayersHere, XP_U16 nPlayersTotal,
|
|
const TransportProcs* procs, XP_U16 forceChannel
|
|
#ifdef SET_GAMESEED
|
|
,XP_U16 gameSeed
|
|
#endif
|
|
);
|
|
|
|
void comms_reset( CommsCtxt* comms, XP_Bool isServer,
|
|
XP_U16 nPlayersHere, XP_U16 nPlayersTotal );
|
|
void comms_resetSame( CommsCtxt* comms );
|
|
void comms_transportFailed( CommsCtxt* comms, CommsConnType failed );
|
|
|
|
void comms_destroy( CommsCtxt* comms );
|
|
|
|
void comms_setConnID( CommsCtxt* comms, XP_U32 connID );
|
|
|
|
/* "static" methods work when no comms present */
|
|
void comms_getInitialAddr( CommsAddrRec* addr
|
|
#ifdef XWFEATURE_RELAY
|
|
, const XP_UCHAR* relayName
|
|
, XP_U16 relayPort
|
|
#endif
|
|
);
|
|
XP_Bool comms_checkAddr( DeviceRole role, const CommsAddrRec* addr,
|
|
XW_UtilCtxt* util );
|
|
|
|
void comms_getAddr( const CommsCtxt* comms, CommsAddrRec* addr );
|
|
void comms_setAddr( CommsCtxt* comms, const CommsAddrRec* addr );
|
|
void comms_getAddrs( const CommsCtxt* comms, CommsAddrRec addr[],
|
|
XP_U16* nRecs );
|
|
XP_Bool comms_formatRelayID( const CommsCtxt* comms, XP_U16 indx,
|
|
XP_UCHAR* buf, XP_U16* lenp );
|
|
|
|
XP_U16 comms_countPendingPackets( const CommsCtxt* comms );
|
|
|
|
|
|
#ifdef XWFEATURE_RELAY
|
|
XP_Bool comms_getRelayID( const CommsCtxt* comms, XP_UCHAR* buf, XP_U16* len );
|
|
#endif
|
|
|
|
CommsConnTypes comms_getConTypes( const CommsCtxt* comms );
|
|
XP_Bool comms_getIsServer( const CommsCtxt* comms );
|
|
|
|
CommsCtxt* comms_makeFromStream( MPFORMAL XWStreamCtxt* stream,
|
|
XW_UtilCtxt* util,
|
|
const TransportProcs* procs,
|
|
XP_U16 forceChannel );
|
|
void comms_start( CommsCtxt* comms );
|
|
void comms_stop( CommsCtxt* comms );
|
|
void comms_writeToStream( CommsCtxt* comms, XWStreamCtxt* stream,
|
|
XP_U16 saveToken );
|
|
void comms_saveSucceeded( CommsCtxt* comms, XP_U16 saveToken );
|
|
|
|
void addrFromStream( CommsAddrRec* addr, XWStreamCtxt* stream );
|
|
void addrToStream( XWStreamCtxt* stream, const CommsAddrRec* addr );
|
|
|
|
XP_S16 comms_send( CommsCtxt* comms, XWStreamCtxt* stream );
|
|
XP_S16 comms_resendAll( CommsCtxt* comms, CommsConnType filter, XP_Bool force );
|
|
XP_U16 comms_getChannelSeed( CommsCtxt* comms );
|
|
|
|
#ifdef XWFEATURE_COMMSACK
|
|
void comms_ackAny( CommsCtxt* comms );
|
|
#endif
|
|
|
|
typedef struct _CommsMsgState {
|
|
struct AddressRecord* rec;
|
|
#ifdef DEBUG
|
|
const CommsCtxt* comms;
|
|
#endif
|
|
} CommsMsgState;
|
|
|
|
XP_Bool comms_checkIncomingStream( CommsCtxt* comms, XWStreamCtxt* stream,
|
|
const CommsAddrRec* addr,
|
|
CommsMsgState* state );
|
|
void comms_msgProcessed( CommsCtxt* comms, CommsMsgState* state,
|
|
XP_Bool rejected );
|
|
XP_Bool comms_checkComplete( const CommsAddrRec* const addr );
|
|
|
|
XP_Bool comms_canChat( const CommsCtxt* comms );
|
|
XP_Bool comms_isConnected( const CommsCtxt* const comms );
|
|
|
|
#ifdef RELAY_VIA_HTTP
|
|
void comms_gameJoined( CommsCtxt* comms, const XP_UCHAR* connname, XWHostID hid );
|
|
#endif
|
|
|
|
CommsConnType addr_getType( const CommsAddrRec* addr );
|
|
void addr_setType( CommsAddrRec* addr, CommsConnType type );
|
|
void addr_addType( CommsAddrRec* addr, CommsConnType type );
|
|
void types_addType( XP_U16* conTypes, CommsConnType type );
|
|
void addr_rmType( CommsAddrRec* addr, CommsConnType type );
|
|
XP_Bool addr_hasType( const CommsAddrRec* addr, CommsConnType type );
|
|
XP_Bool types_hasType( XP_U16 conTypes, CommsConnType type );
|
|
XP_Bool addr_iter( const CommsAddrRec* addr, CommsConnType* typp,
|
|
XP_U32* state );
|
|
XP_Bool types_iter( XP_U32 conTypes, CommsConnType* typp, XP_U32* state );
|
|
|
|
# ifdef DEBUG
|
|
void comms_getStats( CommsCtxt* comms, XWStreamCtxt* stream );
|
|
const char* ConnType2Str( CommsConnType typ );
|
|
const char* CommsRelayState2Str( CommsRelayState state );
|
|
const char* XWREASON2Str( XWREASON reason );
|
|
|
|
void comms_setAddrDisabled( CommsCtxt* comms, CommsConnType typ,
|
|
XP_Bool send, XP_Bool enabled );
|
|
XP_Bool comms_getAddrDisabled( const CommsCtxt* comms, CommsConnType typ,
|
|
XP_Bool send );
|
|
# else
|
|
# define comms_setAddrDisabled( comms, typ, send, enabled )
|
|
# define comms_getAddrDisabled( comms, typ, send ) XP_FALSE
|
|
# endif
|
|
|
|
EXTERN_C_END
|
|
|
|
#endif /* _COMMS_H_ */
|