Codebase list burgerspace / 24206412-2aa9-41b4-b985-7f8c17f14ba2/main src / server.cpp
24206412-2aa9-41b4-b985-7f8c17f14ba2/main

Tree @24206412-2aa9-41b4-b985-7f8c17f14ba2/main (Download .tar.gz)

server.cpp @24206412-2aa9-41b4-b985-7f8c17f14ba2/mainraw · history · blame

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
/*  $Id: server.cpp,v 1.5 2018/06/24 20:53:05 sarrazip Exp $
    server.cpp - main() function for BurgerSpace server

    burgerspace - A hamburger-smashing video game.
    Copyright (C) 2008 Pierre Sarrazin <http://sarrazip.com/>

    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., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#include "BurgerSpaceServer.h"

#include <stdlib.h>
#include <errno.h>
#include <time.h>
#include <errno.h>
#include <limits.h>
#include <sys/types.h>

#include <string>
#include <iostream>
#include <iomanip>
#include <algorithm>
#include <vector>
#include <map>

#ifndef _MSC_VER
#include <sys/time.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <netdb.h>
#include <unistd.h>
#else
#include <WinSock2.h>
#include <ws2tcpip.h>
#endif

#ifdef HAVE_GETOPT_LONG
#include <getopt.h>
#endif

#ifndef DEFAULT_UDP_SERVER_PORT
#error DEFAULT_UDP_SERVER_PORT must be defined to valid UDP port number
#endif

using namespace std;


#ifdef HAVE_GETOPT_LONG
static struct option knownOptions[] =
{
    { "help",          no_argument,       NULL, 'h' },
    { "version",       no_argument,       NULL, 'v' },
    { "initial-level", required_argument, NULL, 'i' },
    { "port",          required_argument, NULL, 'p' },

    { NULL, 0, NULL, 0 }  // marks the end
};


static
void
displayVersionNo()
{
    cout << PROGRAM << " (" << PACKAGE << " " << VERSION << ")" << endl;
}


static
void
displayHelp()
{
    cout << "\n";

    displayVersionNo();

    cout <<
"\n"
"Copyright (C) 2001-2008 Pierre Sarrazin <http://sarrazip.com/>\n"
"This program is free software; you may redistribute it under the terms of\n"
"the GNU General Public License.  This program has absolutely no warranty.\n"
    ;

    cout <<
"\n"
"Known options:\n"
"--help             Display this help page and exit\n"
"--version          Display this program's version number and exit\n"
"--initial-level=N  Start game at level N (N >= 1) [default=1]\n"
"--port=PORT        Listen on specified UDP port [default=" << DEFAULT_UDP_SERVER_PORT << "]\n"
"\n"
    ;
}
#endif  /* HAVE_GETOPT_LONG */


template <class Integer>
inline void
appendUint16(string &s, Integer n)
{
    uint16_t word = static_cast<uint16_t>(n);
    s.append((char *) &word, sizeof(word));
}


template <class Integer>
inline void
appendUint32(string &s, Integer n)
{
    uint32_t dword = static_cast<uint32_t>(n);
    s.append((char *) &dword, sizeof(dword));
}


class GameClient
{
public:

    GameClient()
      : udpPort(0),
        to(),
        role(ROLE_SPECTATOR)
    {
        memset(ipAddr, '\0', 4);
        memset(&to, '\0', sizeof(to));
    }

    GameClient(const unsigned char _ipAddr[4], unsigned short _udpPort, Role _role)
      : udpPort(0),
        to(),
        role(_role)
    {
        init(_ipAddr, _udpPort);
    }

    GameClient(const GameClient &gc)
      : udpPort(0),
        to(),
        role(gc.role)
    {
        init(gc.ipAddr, gc.udpPort);
    }

    GameClient &operator = (const GameClient &gc)
    {
        if (this != &gc)
        {
            role = gc.role;
            init(gc.ipAddr, gc.udpPort);
        }
        return *this;
    }

    void init(const unsigned char _ipAddr[4], unsigned short _udpPort)
    {
        memcpy(ipAddr, _ipAddr, 4);
        udpPort = _udpPort;

        memset(&to, '\0', sizeof(to));
        to.sin_family = AF_INET;
        memcpy(&to.sin_addr, _ipAddr, 4);
        to.sin_port = htons(_udpPort);
    }

    bool isValid() const
    {
        return ipAddr[0] != 0 || ipAddr[1] != 0 || ipAddr[2] != 0 || ipAddr[3] != 0;
    }

    Role getRole() const
    {
        return role;
    }

    void setRole(Role newRole)
    {
        role = newRole;
    }

    bool hasAddress(const unsigned char _ipAddr[4], unsigned short _udpPort) const
    {
        return udpPort == _udpPort && memcmp(ipAddr, _ipAddr, 4) == 0;
    }

    bool operator == (const GameClient &gc) const
    {
        return ipAddr[0] == gc.ipAddr[0]
               && ipAddr[1] == gc.ipAddr[1]
               && ipAddr[2] == gc.ipAddr[2]
               && ipAddr[3] == gc.ipAddr[3]
               && udpPort == gc.udpPort
               && role == gc.role;
    }

    bool operator < (const GameClient &gc) const
    {
        if (ipAddr[0] != gc.ipAddr[0])
            return ipAddr[0] < gc.ipAddr[0];
        if (ipAddr[1] != gc.ipAddr[1])
            return ipAddr[1] < gc.ipAddr[1];
        if (ipAddr[2] != gc.ipAddr[2])
            return ipAddr[2] < gc.ipAddr[2];
        if (ipAddr[3] != gc.ipAddr[3])
            return ipAddr[3] < gc.ipAddr[3];
        if (udpPort != gc.udpPort)
            return udpPort < gc.udpPort;
        return int(role) < int(gc.role);
    }

    ssize_t sendString(const string &p, int sock)
    {
        return sendto(sock, p.data(), p.length(), 0, (const sockaddr *) &to, sizeof(to));
    }

public:
    unsigned char ipAddr[4];
    unsigned short udpPort;
    sockaddr_in to;  // copy of ipAddr+udpPort for sendPacket()
    Role role;
};


class CircularPacketBuffer
{
public:

    CircularPacketBuffer(size_t capacity)
      : vec(capacity),
        reader(0),
        writer(0)
    {
        assert(vec.size() > 0);
        assert(empty());
        assert(!full());
    }

    bool empty() const
    {
        return writer == reader;
    }

    bool full() const
    {
        return nextWriterIndex() == reader;
    }

    size_t size() const
    {
        if (writer >= reader)
            return writer - reader;
        return vec.size() - (reader - writer);
    }

    void add(const string &packet)
    {
        assert(!(empty() && full()));
        if (full())
            removeOldest(1);

        vec[writer] = packet;
        writer = nextWriterIndex();
        assert(!(empty() && full()));
    }

    const string &oldest() const
    {
        assert(!empty());
        return vec[reader];
    }

    void removeOldest(size_t numToRemove)
    {
        assert(numToRemove <= size());
        reader = (reader + numToRemove) % vec.size();
    }

private:

    size_t nextWriterIndex() const
    {
        return (writer + 1) % vec.size();
    }

    vector<string> vec;
    size_t reader;  // index into vec
    size_t writer;  // index into vec
};


class BurgerSpaceCommandLineServer : public BurgerSpaceServer
{
public:

    BurgerSpaceCommandLineServer(int _initLevelNumber, int _sock, Uint32 _minMSBetweenWrites)
      : BurgerSpaceServer(_initLevelNumber, false),
        sock(_sock),
        minMSBetweenWrites(_minMSBetweenWrites),
        pendingLevelUpdatePacket(),
        spriteUpdatePacketTable(),
        pendingSpriteUpdatePackets(400),
        pendingSoundEffectPacket(),
        timeOfLastSend(0),
        pendingScoreUpdatePacket(),
        lastScoreUpdatePacket(),
        timeOfLastScoreUpdate(0),
        numPacketsSent(0),
        totalPacketBytesSent(0),
        gameClientSet()
    {
    }

    /*  If the server socket has any available packets from the client(s),
        this method processes them immediately, then returns.
        If no packets are available, this method returns immediately.
        Writes error messages to cerr.
    */
    void processAvailableIncomingPackets();

    GameClient *insertGameClient(const unsigned char _ipAddr[4], unsigned short _udpPort, Role _requestedRole)
    {
        if (haveClientWithRole(_requestedRole))
            _requestedRole = ROLE_SPECTATOR;
        gameClientSet.push_back(GameClient(_ipAddr, _udpPort, _requestedRole));
        return &gameClientSet.back();
    }

    void eraseGameClient(const GameClient &gc)
    {
        std::vector<GameClient>::iterator newEnd =
                        remove(gameClientSet.begin(), gameClientSet.end(), gc);
        gameClientSet.erase(newEnd, gameClientSet.end());
    }

    virtual void updateLevel(int levelNo, size_t numRows, size_t numColumns, flatzebra::Couple levelPos, const std::string &desc)
    {
        //cout << "updateLevel(" << levelNo << ", " << numRows << ", " << numColumns << ", (" << levelPos.x << ", " << levelPos.y << "), '" << desc << "')" << endl;
        assert(desc.length() == numRows * numColumns);

        pendingLevelUpdatePacket.clear();
        appendUint16(pendingLevelUpdatePacket, UPDATE_LEVEL_PACKET);
        appendUint16(pendingLevelUpdatePacket, levelNo);
        appendUint16(pendingLevelUpdatePacket, numRows);
        appendUint16(pendingLevelUpdatePacket, numColumns);
        appendUint16(pendingLevelUpdatePacket, levelPos.x);
        appendUint16(pendingLevelUpdatePacket, levelPos.y);
        appendUint16(pendingLevelUpdatePacket, desc.length());
        pendingLevelUpdatePacket += desc;
        //cout << "updateLevel: pendingLevelUpdatePacket now " << pendingLevelUpdatePacket.length() << " chars" << endl;

        // Force update of all sprites upon level change.
        spriteUpdatePacketTable.clear();
    }

    virtual void updateSprite(uint32_t id, SpriteType type, flatzebra::Couple pos, size_t pixmapIndex)
    {
        //cout << "updateSprite(" << type << ", (" << pos.x << ", " << pos.y << "), " << pixmapIndex << ")" << endl;
        Uint32 now = SDL_GetTicks();
        Uint32 elapsed = now - timeOfLastSend;
        if (elapsed < minMSBetweenWrites)
            return;
        //cout << "updateSprite: " << elapsed << " ms; " << pendingSpriteUpdatePackets.size() << " SUs" << endl;

        string packet;
        appendUint32(packet, id);
        appendUint16(packet, type);
        appendUint16(packet, pos.x);
        appendUint16(packet, pos.y);
        appendUint16(packet, pixmapIndex == size_t(-1) ? USHRT_MAX : pixmapIndex);
        assert(packet.length() == UPDATE_SPRITE_PACKET_LEN);

        // Remember packet sent for each sprite ID.
        // If this packet has not changed since last send,
        // then don't send it again.
        if (registerSpriteUpdatePacket(id, packet))
            pendingSpriteUpdatePackets.add(packet);
    }

    virtual void notifySpriteDeletion(uint32_t id)
    {
        string packet;
        appendUint32(packet, id);
        appendUint16(packet, NO_SPRITE);  // indicates deletion
        appendUint16(packet, 0);
        appendUint16(packet, 0);
        appendUint16(packet, 0);
        assert(packet.length() == UPDATE_SPRITE_PACKET_LEN);

        if (registerSpriteUpdatePacket(id, packet))
            pendingSpriteUpdatePackets.add(packet);
    }

    virtual void updateScore(long theScore, int numLives, int numAvailablePeppers, int cumulLevelNo, bool forceTransmission)
    {
        Uint32 now = SDL_GetTicks();
        if (now - timeOfLastScoreUpdate < 55)
            return;

        string newScoreUpdatePacket;
        appendUint16(newScoreUpdatePacket, UPDATE_SCORE_PACKET);
        appendUint32(newScoreUpdatePacket, theScore);
        appendUint16(newScoreUpdatePacket, numLives);
        appendUint16(newScoreUpdatePacket, numAvailablePeppers);
        appendUint16(newScoreUpdatePacket, cumulLevelNo);

        if (!forceTransmission && newScoreUpdatePacket == lastScoreUpdatePacket)
            return;

        //cout << "updateScore: " << theScore << " " << numLives << " " << numAvailablePeppers << " " << cumulLevelNo << endl;
        pendingScoreUpdatePacket = newScoreUpdatePacket;
        timeOfLastScoreUpdate = now;
    }

    virtual void playSoundEffect(SoundEffect se)
    {
        //cout << "playSoundEffect(" << se << ")" << endl;
        pendingSoundEffectPacket.clear();
        appendUint16(pendingSoundEffectPacket, PLAY_SOUND_EFFECT_PACKET);
        appendUint16(pendingSoundEffectPacket, se);
    }

    virtual EnemyType chooseEnemyType()
    {
        flatzebra::SpriteList::const_iterator it;
        for (it = enemySprites.begin(); it != enemySprites.end(); it++)
            if ((*it)->getPixmapArray() == &eggPA)
            {
                // There is already an egg among the existing enemies.
                // Since the egg is controlled by the user, none of the
                // computer-controlled enemies are eggs, to avoid confusion.
                return enemyTypeCounter++ % 2 == 0 ? ENEMY_HOT_DOG : ENEMY_PICKLE;
            }
        return ENEMY_EGG;  // no egg, so create one
    }

    virtual bool isUserControlledEnemy(const flatzebra::Sprite &s) const
    {
        return s.getPixmapArray() == &eggPA;
    }

    virtual void disconnect()
    {
    }

    virtual bool saveGame(std::ostream &/*out*/)
    {
        return false;  // save not supported in client-server mode
    }

    virtual int loadGame(std::istream &/*in*/)
    {
        return -1;  // load not supported in client-server mode
    }

    void sendPendingPacketsToClientSet()
    {
        //cerr << pendingSpriteUpdatePackets.size() << endl;

        // Prepare a "batch" packet that contains several
        // sprite update sub-packets to be sent to each client.
        // This removes the oldest elements of pendingSpriteUpdatePackets.
        // Note that this prevents pendingSpriteUpdatePackets from growing
        // indefinitely while waiting for clients: the oldest elements are
        // removed even when no client is connected.
        //
        string spriteUpdateBatchPacket;
        buildSpriteUpdateBatchPacket(spriteUpdateBatchPacket);

        // For each connected client, send any pending packets.
        for (vector<GameClient>::iterator it = gameClientSet.begin();
                                                it != gameClientSet.end(); ++it)
            sendPendingPackets(*it, spriteUpdateBatchPacket);

        // Clear pending packets.
        pendingLevelUpdatePacket.clear();
        pendingSoundEffectPacket.clear();
        pendingScoreUpdatePacket.clear();
    }

    GameClient *getGameClientByAddress(const unsigned char _ipAddr[4], unsigned short _udpPort)
    {
        for (vector<GameClient>::iterator it = gameClientSet.begin();
                                            it != gameClientSet.end(); ++it)
            if (it->hasAddress(_ipAddr, _udpPort))
                return &*it;
        return NULL;
    }

    bool haveClientWithRole(Role role) const
    {
        for (vector<GameClient>::const_iterator it = gameClientSet.begin();
                                            it != gameClientSet.end(); ++it)
            if (it->getRole() == role)
                return true;
        return false;
    }

    size_t getNumGameClients() const
    {
        return gameClientSet.size();
    }

    bool haveTwoPlayers() const
    {
        return haveClientWithRole(ROLE_CHEF) && haveClientWithRole(ROLE_ENEMY);
    }

    void getStats(size_t &_numPacketsSent, ssize_t &_totalPacketBytesSent)
    {
        _numPacketsSent = numPacketsSent;
        _totalPacketBytesSent = totalPacketBytesSent;
    }

private:

    void sendPendingPackets(GameClient &client, const string &spriteUpdateBatchPacket)
    {
        //cout << "sendPendingPackets: " << pendingLevelUpdatePacket.length() << " " << pendingSpriteUpdatePackets.size() << endl;

        if (pendingLevelUpdatePacket.length() > 0)
        {
            sendPacket(pendingLevelUpdatePacket, client);
        }
        if (spriteUpdateBatchPacket.size() > 0)
        {
            sendPacket(spriteUpdateBatchPacket, client);
        }
        if (pendingSoundEffectPacket.length() > 0)
        {
            sendPacket(pendingSoundEffectPacket, client);
        }
        if (pendingScoreUpdatePacket.length() > 0)
        {
            sendPacket(pendingScoreUpdatePacket, client);
            lastScoreUpdatePacket = pendingScoreUpdatePacket;
        }
    }

    void buildSpriteUpdateBatchPacket(string &batchPacket)
    {
        batchPacket.clear();

        if (pendingSpriteUpdatePackets.size() == 0)
            return;

        // Compute number of updates that fit in a packet
        // of at most MAX_LEN_PACKET bytes.
        size_t maxUpdates = (MAX_LEN_PACKET - 2 - 2) / UPDATE_SPRITE_PACKET_LEN;
        size_t numToSend = min(pendingSpriteUpdatePackets.size(), maxUpdates);

        assert(numToSend <= pendingSpriteUpdatePackets.size());

        batchPacket.reserve(MAX_LEN_PACKET);
        appendUint16(batchPacket, UPDATE_SPRITE_PACKET);
        appendUint16(batchPacket, numToSend);

        for (size_t j = 0; j < numToSend; ++j)
        {
            const string &packet = pendingSpriteUpdatePackets.oldest();
            assert(packet.length() == UPDATE_SPRITE_PACKET_LEN);
            batchPacket += packet;
            pendingSpriteUpdatePackets.removeOldest(1);
        }

        //cout << "UPDATE_SPRITE_PACKET: max=" << maxUpdates << ", numToSend=" << numToSend << ", vector=" << pendingSpriteUpdatePackets.size() << pendingSpriteUpdatePackets.size() << ", singlePacket=" << singlePacket.length() << endl;

        assert(batchPacket.length() == 2 + 2 + numToSend * UPDATE_SPRITE_PACKET_LEN);
        assert(batchPacket.length() <= MAX_LEN_PACKET);
    }

private:

    void sendPacket(const string &p, GameClient &client)
    {
        ssize_t numBytesSent = client.sendString(p, sock);
        //cerr << "Sent " << numBytesSent << " bytes of packet of " << p.length() << " bytes" << endl;
        if (numBytesSent != ssize_t(p.length()))
        {
            int e = errno;
            cout << PROGRAM << ": sendPacket: tried to send " << p.length() << " bytes but only " << numBytesSent << " sent: " << strerror(e) << endl;
        }
        else
        {
            ++numPacketsSent;
            totalPacketBytesSent += numBytesSent;
            //cout << "sendPacket: sent " << numBytesSent << " bytes to " << hex
                    //<< to.sin_addr.s_addr << dec << ":" << to.sin_port << endl;
            timeOfLastSend = SDL_GetTicks();
        }
    }

    // Registers the given packet string with the given sprite ID.
    // If spriteUpdatePacketTable does not already have any entry for spriteId,
    // then a new entry is added and this method returns true.
    // If spriteUpdatePacketTable already has any entry for spriteId,
    // then the packet string is stored in this entry and this method
    // returns true.
    // Otherwise, this method returns false, to indicate that 'packet' was
    // exactly the sprite update packet that was last sent to 'spriteId'
    // (thus, it need not be sent again).
    //
    bool registerSpriteUpdatePacket(uint32_t spriteId, const string &packet)
    {
        map<uint32_t, string>::iterator it = spriteUpdatePacketTable.find(spriteId);
        if (it == spriteUpdatePacketTable.end())
        {
            spriteUpdatePacketTable[spriteId] = packet;
            return true;
        }
        if (it->second != packet)
        {
            it->second = packet;
            return true;
        }
        return false;
    }


    int sock;
    Uint32 minMSBetweenWrites;  // minimum period in milliseconds between writes to client(s)
    string pendingLevelUpdatePacket;
    map<uint32_t, string> spriteUpdatePacketTable;  // key: sprite ID; value: last sent sprite update packet for this ID
    CircularPacketBuffer pendingSpriteUpdatePackets;
    string pendingSoundEffectPacket;
    Uint32 timeOfLastSend;  // maintained by sendPacket()
    string pendingScoreUpdatePacket;
    string lastScoreUpdatePacket;
    Uint32 timeOfLastScoreUpdate;  // used to space out score updates
    size_t numPacketsSent;
    ssize_t totalPacketBytesSent;
    std::vector<GameClient> gameClientSet;

};


void
BurgerSpaceCommandLineServer::processAvailableIncomingPackets()
{
    char buffer[MAX_LEN_PACKET];
    sockaddr_in from;

    for (;;)
    {
        memset(&from, '\0', sizeof(from));
        socklen_t length = sizeof(from);
        int flags = 0;
        #ifndef _MSC_VER
        flags = MSG_DONTWAIT;
        #endif
        ssize_t numBytesReceived = recvfrom(sock, buffer, sizeof(buffer), flags, (sockaddr *) &from, &length);
        int e = errno;
        if (numBytesReceived < 0)  // if error or no packet available
        {
            if (e != EAGAIN)  // if error
                cerr << PROGRAM << ": receive error from socket: " << strerror(e) << endl;
            break;
        }
        if (numBytesReceived == 0)
            continue;

        const unsigned char *ipAddr = (unsigned char *) &from.sin_addr.s_addr;
        unsigned short port = (unsigned short) ntohs(from.sin_port);

        GameClient *gameClient = getGameClientByAddress(ipAddr, port);

        #if 0
        cout << "Got " << numBytesReceived << " bytes (" << hex << int(buffer[0]) << ") from 0x"
                << (unsigned long) from.sin_addr.s_addr << ":0x" << from.sin_port << dec
                << ", role=" << (gameClient == NULL ? -1 : gameClient->getRole()) << endl;
        #endif

        switch (static_cast<ClientPacketType>(buffer[0]))
        {
            case CLIENT_DESC_PACKET:  // must be 1st packet from newly connected client
                assert(numBytesReceived == 2);
                if (gameClient != NULL)
                {
                    cerr << PROGRAM << ": PLAYER_COMMAND_PACKET from already connected client" << endl;
                    break;
                }
                {
                    int role = static_cast<int>(buffer[1]);
                    if (role != ROLE_SPECTATOR
                            && role != ROLE_CHEF
                            && role != ROLE_ENEMY)
                    {
                        cerr << PROGRAM << ": PLAYER_COMMAND_PACKET contains invalid role number" << endl;
                        role = ROLE_SPECTATOR;
                    }
                    gameClient = insertGameClient(ipAddr, port, static_cast<Role>(role));
                    assert(gameClient != NULL);

                    // Send the client the role actually assigned by the server:
                    string roleAssignmentPacket;
                    appendUint16(roleAssignmentPacket, ROLE_ASSIGNMENT_PACKET);
                    roleAssignmentPacket += char(gameClient->getRole());
                    gameClient->sendString(roleAssignmentPacket, sock);
                }
                break;

            case PLAYER_COMMAND_PACKET:
            {
                if (gameClient == NULL)
                {
                    cerr << PROGRAM << ": PLAYER_COMMAND_PACKET from unknown client" << endl;
                    break;
                }

                assert(numBytesReceived == 6);
                bool directions[4] =
                    {
                        buffer[1] != '\0',
                        buffer[2] != '\0',
                        buffer[3] != '\0',
                        buffer[4] != '\0'
                    };

                switch (gameClient->getRole())
                {
                    case ROLE_CHEF:
                        setChefRequest(directions, buffer[5] != '\0');
                        break;
                    case ROLE_ENEMY:
                        setEnemyRequest(directions);
                        break;
                    case ROLE_SPECTATOR:
                        break;
                }
                break;
            }

            case START_NEW_GAME_PACKET:  // if request for start of new game
                if (gameClient == NULL)
                    cerr << PROGRAM << ": START_NEW_GAME_PACKET from unknown client" << endl;
                else if (gameClient->getRole() == ROLE_CHEF /*&& haveTwoPlayers()*/)
                {
                    assert(numBytesReceived == 1);
                    startNewGame();
                }
                break;

            case LEVEL_DESC_REQUEST_PACKET:  // if request for level description
                if (gameClient != NULL)
                {
                    sendLevelUpdate();
                    sendScoreUpdate();
                }
                else
                    cerr << PROGRAM << ": START_NEW_GAME_PACKET from unknown client" << endl;
                break;

            case DISCONNECT_PACKET:  // client is disconnecting
                if (gameClient != NULL)
                    eraseGameClient(*gameClient);
                else
                    cerr << PROGRAM << ": DISCONNECT_PACKET from unknown client" << endl;
                break;

            default:
                cerr << PROGRAM << ": unexpected packet of type " << int(buffer[0])
                        << " received from client" << endl;
        }
    }
}


#ifdef _MSC_VER
#undef main  // undo redefinition of "main" by SDL_main.h
#endif

int
main(int argc, char *argv[])
{
    /*  Default game parameters:
    */
    int initLevelNo = 1;
    unsigned short port = DEFAULT_UDP_SERVER_PORT;
    Uint32 minMSBetweenWrites = 25;



    #ifdef HAVE_GETOPT_LONG

    /*  Interpret the command-line options:
    */
    int c;
    do
    {
        c = getopt_long(argc, argv, "", knownOptions, NULL);

        switch (c)
        {
            case EOF:
                break;  // nothing to do

            case 'i':
                {
                    errno = 0;
                    long n = strtol(optarg, NULL, 10);
                    if (errno == ERANGE || n < 1 || n > 500)
                    {
                        cerr << "Invalid initial level number." << endl;
                        displayHelp();
                        return EXIT_FAILURE;
                    }

                    initLevelNo = int(n);
                }
                break;

            case 'p':
                {
                    char *end = NULL;
                    long n = strtol(optarg, &end, 10);
                    if (n < 0 || n > 65535 || end == optarg || *end != '\0')
                    {
                        cerr << PROGRAM << ": --port: invalid UDP port number " << optarg << endl;
                        return EXIT_FAILURE;
                    }
                    port = static_cast<unsigned short>(n);
                }
                break;

            case 'v':
                displayVersionNo();
                return EXIT_SUCCESS;

            case 'h':
                displayHelp();
                return EXIT_SUCCESS;

            default:
                displayHelp();
                return EXIT_FAILURE;
        }
    } while (c != EOF && c != '?');

    #endif  /* HAVE_GETOPT_LONG */


    /*  Initialize the random number generator:
    */
    const char *s = getenv("SEED");
    unsigned int seed = (unsigned int) (s != NULL ? atol(s) : time(NULL));
    #ifndef NDEBUG
    cerr << "seed = " << seed << endl;
    cerr << "init-level-no = " << initLevelNo << endl;
    #endif
    srand(seed);

    try
    {
        #ifdef _MSC_VER
        WSADATA wsaData;
        if (WSAStartup(MAKEWORD(2, 2), &wsaData) != 0)
        {
            cout << PROGRAM << ": WSAStartup failed: winsock error #" << WSAGetLastError() << endl;
            return EXIT_FAILURE;
        }

        // Use destructor to ensure that winsock gets closed.
        struct Cleanup { ~Cleanup() { WSACleanup(); } } cleanup;
        #endif

        /*  Create a UDP server socket.
        */
        int sock = socket(AF_INET, SOCK_DGRAM, 0);
        if (sock < 0)
        {
            #ifndef _MSC_VER
            int e = errno;
            cout << PROGRAM << ": failed to create server socket: " << strerror(e) << endl;
            #else
            cout << PROGRAM << ": failed to create server socket: winsock error #" << WSAGetLastError() << endl;
            #endif
            return EXIT_FAILURE;
        }
        sockaddr_in server;
        memset(&server, '\0', sizeof(server));
        server.sin_family = AF_INET;
        server.sin_addr.s_addr = INADDR_ANY;
        server.sin_port = htons(port);
        if (::bind(sock, (sockaddr *) &server, sizeof(server)) < 0)
        {
            int e = errno;
            cout << PROGRAM << ": failed to bind to server port " << port << ": " << strerror(e) << endl;
            return EXIT_FAILURE;
        }
        cout << PROGRAM << ": server bound to port " << port << endl;

        #ifdef _MSC_VER
        u_long iMode = 1;
        ioctlsocket(sock, FIONBIO, &iMode);  // non blocking mode
        #endif


        /*  Create the "game logic" object.
        */
        BurgerSpaceCommandLineServer theBurgerSpaceServer(initLevelNo, sock, minMSBetweenWrites);
        theBurgerSpaceServer.finishInit();  // calls virtual functions


        /*  Main loop: process incoming network packets if any are available;
            update the game logic; send all pending response packets to the
            client(s); delay until the end of the current frame.
        */
        const Uint32 millisecondsPerFrame = 55;
        #undef STATS
        #ifdef STATS
        const Uint32 gameStartTime = SDL_GetTicks();
        #endif

        for (Uint32 frameCount = 0; ; ++frameCount)
        {
            Uint32 frameEnd = SDL_GetTicks() + millisecondsPerFrame;

            theBurgerSpaceServer.processAvailableIncomingPackets();

            #ifdef STATS
            if (frameCount % 20 == 0)
            {
                Uint32 totalElapsedTime = SDL_GetTicks() - gameStartTime;
                size_t numPacketsSent;
                ssize_t totalPacketBytesSent;
                theBurgerSpaceServer.getStats(numPacketsSent, totalPacketBytesSent);
                cout << "Stats: " << numPacketsSent << " packets, "
                        << totalPacketBytesSent << " B, "
                        << totalElapsedTime / 1000.0f << " s";
                if (numPacketsSent > 0)
                    cout << ", " << totalPacketBytesSent / numPacketsSent << " B/packet";
                if (totalElapsedTime > 0)
                    cout << ", " << totalPacketBytesSent * 1000 / totalElapsedTime << " B/s, "
                            << numPacketsSent * 1000 / totalElapsedTime << " packets/s";
                cout << ", " << theBurgerSpaceServer.getNumGameClients() << " client(s)";
                cout << endl;
            }
            #endif

            if (!theBurgerSpaceServer.update())
                break;

            theBurgerSpaceServer.sendPendingPacketsToClientSet();

            Uint32 now = SDL_GetTicks();
            if (frameEnd > now)
                SDL_Delay(frameEnd - now);
        }
    }
    catch (const string &s)
    {
        cerr << PROGRAM << ": server init error: " << s << endl;
        return EXIT_FAILURE;
    }
    catch (int e)
    {
        cerr << PROGRAM << ": init error # " << e << endl;
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}