main.h

/*
 * main.h
 *
 * PWLib application header file for server
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * Copyright (c) 2006 Indranet Technologies Ltd
 *
 * The Original Code is Sofa Switch
 *
 * The Initial Developer of the Original Code is Derek J Smithies
 *
 * $Log: main.h,v $
 * Revision 1.32  2006/05/15 04:43:38  derek
 * Add to debugging information. Tidy up close down procedure for non used nodes.
 *
 * Revision 1.31  2006/05/10 04:08:23  derek
 * Add status full command, and the ability to track the number of created
 * TcpConnection classes
 *
 * Revision 1.30  2006/05/09 03:10:12  derek
 * More fixes, so as to cope with lots of concurrent messages.
 *
 * Revision 1.29  2006/05/09 02:11:24  derek
 * add multiple fixes, so it correctly handles empty messages, and correctly terminates.
 *
 * Revision 1.28  2006/04/24 03:47:08  derek
 * Updates to get the server to work correctly, and compile issues for jopal
 *
 * Revision 1.27  2006/03/31 04:44:00  derek
 * Modifications, to ensure all is deleted and closed down corectly.
 *
 * Revision 1.26  2006/03/23 08:19:12  derek
 * Fix threading issues for SMP machines.
 *
 * Revision 1.25  2006/03/22 01:30:48  derek
 * Add logging statements for error type things, and reduce the number of
 * memory allocations to handle each message.
 * Make use of const in passing parameters.
 *
 * Revision 1.24  2006/03/21 01:33:46  derek
 * tidyups tidyups, fix licenses, fix makefiles,
 *
 * Revision 1.23  2006/03/16 01:59:03  derek
 * Remove audio read write thread pointers from the am.
 * tidy up the handling of the remoteController name in the MessageFrame class.
 * Extend the python control scripts to be a bit tougher.
 *
 * Revision 1.22  2006/03/10 02:43:10  derek
 * add flag to report when messages are sent to the remote node.
 * Tidyup the displayed code.
 * Adjust the time that the output mutex is locked.
 *
 * Revision 1.21  2006/01/23 07:28:55  derek
 * Modify some print statements,
 *
 * Revision 1.20  2006/01/23 04:09:51  derek
 * Add reporting function.
 *
 * Revision 1.19  2006/01/18 03:57:52  derek
 * Minor tidyups to chase a memory management bug. Proves to be in the glibc of
 * the Fedora Core 1 testbox.
 *
 * Revision 1.18  2006/01/12 22:56:53  derek
 * Tidy up documentation. Use a pointer in local storage for the manager.
 *
 * Revision 1.17  2006/01/12 04:12:48  derek
 * Work on documentating the protocol, and rename the Server class inside main.cxx/main.h
 *
 * Revision 1.16  2006/01/09 04:23:38  derek
 * Move Resume() out of constructor for any class. Resuming within a constructor is bad,
 * as it creates a thread before the class is finished building.
 *
 * Revision 1.15  2005/12/14 04:07:36  derek
 * Add a thread & list to prebuild comms before they are needed, to speed the call setup process.
 * It is also allows us to cope better with the times when Comms setup fails.
 *
 * Revision 1.14  2005/12/12 00:25:42  derek
 * Fix the close down etc process of dead TcpConnections. Excise memory leaks.
 *
 * Revision 1.13  2005/12/07 00:44:13  derek
 * given results from the program to test the server, get the messaging code
 * to attempt to reconnect to the server. Modify server to have
 * prebuilt, ready to go TcpConnections which do an accept after receiving
 * a request to the server's listen
 *
 * Revision 1.12  2005/12/05 04:07:05  derek
 * Modify server to end more cleanly.
 * Work on adding additional debugging messages.
 * Move work out of the constructors.
 *
 * Revision 1.11  2005/12/01 02:25:49  derek
 * update server to exit cleanly.
 *
 * Revision 1.10  2005/11/29 23:26:42  derek
 * put keep alives and code to detect the death of the connection.
 *
 * Revision 1.9  2005/11/17 23:17:52  derek
 * Add a short lived thread to actually delete TcpConnection class, rather than
 * trying to do it elsewhere.
 *
 * Revision 1.8  2005/11/13 23:52:26  derek
 * Work on documentation.
 *
 * Revision 1.7  2005/11/08 23:20:08  derek
 * Fix close down process for C++ code.
 * Add "list" option, so remote node can see who is on.
 *
 * Revision 1.6  2005/11/07 23:11:54  derek
 * Add ability to close the server by sending the message "quitnow"
 *
 * Revision 1.5  2005/11/07 04:06:08  derek
 * Add a null byte to the end of the id, which ensures the id is not merged
 * into the next message by the network stack.
 *
 * Revision 1.4  2005/11/06 21:29:49  derek
 * Add null bytes to the end of each message sent.
 *
 * Revision 1.3  2005/11/04 04:00:32  derek
 * Add handling to cope with multiple text messages in one packet.
 * Each message is terminated by a 0 character.
 *
 * Revision 1.2  2005/11/04 02:43:07  derek
 * Add loop counting options to cause program exit.
 * Fix warnings about unused variables.
 *
 * Revision 1.1  2005/11/04 01:35:52  derek
 * Initial release of a C++ based simple messaging server
 *
 *
 *
 *
 *
 *
 */
 
#ifndef _MAIN_H
#define _MAIN_H

#pragma interface

#include <ptlib.h>
#include <ptlib/sockets.h>
#include <ptlib/safecoll.h>



class TcpConnectionList;
class TcpConnection;
class Manager;


class TcpConnection : public PSafeObject
{
  PCLASSINFO(TcpConnection, PSafeObject);
 public:
  TcpConnection(Manager & _mgr);
  
  ~TcpConnection();

  void StartRunning();

  BOOL IsRunning();

  void PrintOn(ostream & strm) const;

  void Terminate();

  void AssignSourceId(PString & newId) { sourceId = newId; }

  PString GetSourceId() { return sourceId; }

  void Clear();

  void StartWorkNow(PTCPSocket &listener);

  void StartWorkNowNotPossible();

 protected:

  PString GetNow();

  void DoOneMessage();

  void BreakUpMessageBlock(PBYTEArray & src, PINDEX srcLen, PStringArray & result);

  void ProcessOneTextMessage(const PString & txt);
  
  void SendThisMessage(PBYTEArray & msg);

  Manager & manager;    

#ifdef DOC_PLUS_PLUS

    virtual void OnReleaseThreadMain(PThread &, INT);
#else
    PDECLARE_NOTIFIER(PThread, TcpConnection, OnReleaseThreadMain);
#endif

    virtual void OnReleased();
    
    PMutex writeMessageLock;
    
    PMutex   incomingLock;
    
    PThread  *incomingMessages;
    
#ifdef DOC_PLUS_PLUS

    virtual void IncomingMessagesMain(PThread &, INT);
#else
    PDECLARE_NOTIFIER(PThread, TcpConnection, IncomingMessagesMain);
#endif
    
  PSyncPoint socketInitialised;
  
  PTCPSocket messagesSocket;
  
  PString sourceId;  

  enum {
    readArraySize = 10  
  };

  PINDEX readArray[readArraySize];

  PINDEX readArrayIndex;

  PMutex clearMutex;

  BOOL isClearing;

  BOOL reportReadMessages;

  BOOL reportSentMessages;

  PBYTEArray message;

  PString thisThreadName;

  PString clearName;

  PString globalUniqueId;
};


PDECLARE_LIST (TcpConnectionList, TcpConnection *)
#ifdef DOC_PLUS_PLUS     //This makes emacs bracket matching code happy.
class TcpConnectionList : public TcpConnection *
{
#endif

  ~TcpConnectionList();

  void CloseDown();

  void Initialise();

  #ifdef DOC_PLUS_PLUS

  void FillListWithTcpConnections(PThread &, INT param);
#else
  PDECLARE_NOTIFIER(PThread, TcpConnectionList, FillListWithTcpConnections);
#endif

  TcpConnection * GetNextTcpConnection();

  PINDEX GetListSize() { PWaitAndSignal m(accessMutex); return PAbstractList::GetSize(); }

 protected:
  TcpConnection *MakeOneTcpConnection();

  PSyncPoint checkListContents;

  PMutex accessMutex;

  PThread *createNewTcpConnections;

  PMutex mutexNewTcpConnections;

  BOOL endNow;
};


class Manager : public PObject
{
  PCLASSINFO(Manager, PObject);
 public:
  Manager();

  ~Manager();

    PSafePtr<TcpConnection> GetConnectionWithLock(
      const PString & token     
      ,PSafetyMode mode = PSafeReadWrite  
    ) { return connectionsActive.FindWithLock(token, mode); }
 
    void RemoveNode(const PString & token);

    void WaitForIncoming();

    PString ProcessMessagesName();

    void AppendRunning(PSafePtr<TcpConnection> conn, const PString & id);

    void AppendDead(PSafePtr<TcpConnection> conn);

    void QuitNow();

    void StopIncomingConnections();

    void GetListConnectedNodes(PStringArray & nodes);

    BOOL KeepRunning() { return keepRunning; }

    void OnReleased(TcpConnection & connection);

    void WaitForEmpty();

    void GetStatus(PStringStream &status);

    PString GetNextBogusId();    
 protected:

 class ConnectionDict : public PSafeDictionary<PString, TcpConnection>
    {
        virtual void DeleteObject(PObject * object) const;
    } connectionsActive;

#ifdef DOC_PLUS_PLUS

 virtual void DoQuitNow(PThread &, INT);
#else
 PDECLARE_NOTIFIER(PThread, Manager, DoQuitNow);
#endif
 
    PTCPSocket listener;

    PAtomicInteger bogusCount;

    PAtomicInteger connectionCount;

    TcpConnectionList availableTcpConnections;

    BOOL keepRunning;

    BOOL isQuitting;

    PMutex quitNowMutex;
};


class ServerProcess : public PProcess
{
  PCLASSINFO(ServerProcess, PProcess);

public:
  ServerProcess();

  ~ServerProcess();

  void Main();

  static ServerProcess & Current()
    { return (ServerProcess &)PProcess::Current(); }

  BOOL ReportReadMessages() { return reportReadMessages; }

  BOOL ReportSentMessages() { return reportSentMessages; }

  Manager & GetManager() { return localManager; }

 protected:

  Manager localManager;

  BOOL reportReadMessages;

  BOOL reportSentMessages;
};

#endif  // _MAIN_H

---