gserver.h

Go to the documentation of this file.

//
// Copyright (C) 2001-2013 Graeme Walker <graeme_walker@users.sourceforge.net>
// 
// 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 3 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, see <http://www.gnu.org/licenses/>.
// ===

#ifndef G_SERVER_H 
#define G_SERVER_H

#include "gdef.h"
#include "gnet.h"
#include "gsocket.h"
#include "gsocketprotocol.h"
#include "gtimer.h"
#include "gconnection.h"
#include "gconnectionlookup.h"
#include "gevent.h"
#include <utility>
#include <list>
#include <memory>
#include <string>

namespace GNet
{
        class Server ;
        class ServerPeer ;
        class ServerPeerTimer ;
        class ServerPeerHandle ;
}

class GNet::ServerPeerHandle 
{
public:
        ServerPeerHandle() ;

        void set( ServerPeer * p ) ;

        void reset() ;

        ServerPeer * peer() ;

        ServerPeer * old() ;

private:
        ServerPeer * m_p ;
        ServerPeer * m_old ;
} ;

class GNet::Server : public GNet::EventHandler 
{
public:
        G_EXCEPTION( CannotBind , "cannot bind the listening port" ) ;
        G_EXCEPTION( CannotListen , "cannot listen" ) ;
        G_EXCEPTION( AcceptError , "socket accept() failed" ) ;

        struct PeerInfo 
        {
                std::auto_ptr<StreamSocket> m_socket ;
                Address m_address ;
                std::string m_name ; // for local peers - not always available
                ServerPeerHandle * m_handle ;
                PeerInfo() ;
        } ;

        static bool canBind( const Address & listening_address , bool do_throw ) ;

        explicit Server( unsigned int listening_port , ConnectionLookup * = NULL ) ;

        explicit Server( const Address & listening_address , ConnectionLookup * = NULL ) ;

        Server() ;

        void init( unsigned int listening_port ) ;

        void init( const Address & listening_address ) ;

        virtual ~Server() ;

        std::pair<bool,Address> address() const ;

        virtual void readEvent() ;

        virtual void writeEvent() ;

        virtual void onException( std::exception & e ) ;

protected:
        virtual ServerPeer * newPeer( PeerInfo ) = 0 ;

        void serverCleanup() ;

private:
        Server( const Server & ) ; // not implemented
        void operator=( const Server & ) ; // not implemented
        void serverCleanupCore() ;
        void collectGarbage() ;
        void accept( PeerInfo & ) ;

private:
        typedef std::list<ServerPeerHandle> PeerList ;
        std::auto_ptr<StreamSocket> m_socket ;
        ConnectionLookup * m_connection_lookup ;
        PeerList m_peer_list ;
        bool m_cleaned_up ;
} ;

class GNet::ServerPeer : public GNet::EventHandler , public GNet::Connection , public GNet::SocketProtocolSink 
{
public:
        typedef std::string::size_type size_type ;

        explicit ServerPeer( Server::PeerInfo ) ;

        bool send( const std::string & data , std::string::size_type offset = 0U ) ;

        void doDelete( const std::string & = std::string() ) ; 

        std::string logId() const ;

        virtual std::pair<bool,Address> localAddress() const ;

        virtual std::pair<bool,Address> peerAddress() const ;

        virtual std::string peerCertificate() const ;

        virtual void readEvent() ; 

        virtual void writeEvent() ;

        virtual void onException( std::exception & ) ;

        void doDeleteThis( int ) ;

protected:
        virtual ~ServerPeer() ;

        virtual void onDelete( const std::string & reason ) = 0 ;

    virtual void onSendComplete() = 0 ;

        void sslAccept() ;

        StreamSocket & socket() ;

        Server * server() ;

private:
        ServerPeer( const ServerPeer & ) ; // not implemented
        void operator=( const ServerPeer & ) ; // not implemented
        void onTimeout() ;

private:
        Address m_address ;
        std::auto_ptr<StreamSocket> m_socket ; // order dependency -- first
        SocketProtocol m_sp ; // order dependency -- second
        ServerPeerHandle * m_handle ;
        Timer<ServerPeer> m_delete_timer ;
} ;

#endif