gsimpleclient.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_SIMPLE_CLIENT_H 
#define G_SIMPLE_CLIENT_H

#include "gdef.h"
#include "gnet.h"
#include "gaddress.h"
#include "gmemory.h"
#include "gconnection.h"
#include "gexception.h"
#include "geventhandler.h"
#include "gresolver.h"
#include "gresolverinfo.h"
#include "gsocket.h"
#include "gsocketprotocol.h"
#include "gevent.h"
#include <string>

namespace GNet
{
        class SimpleClient ;
        class ClientResolver ;
}

class GNet::ClientResolver : public GNet::Resolver 
{
private:
        SimpleClient & m_client ;

public:
        explicit ClientResolver( SimpleClient & ) ;

        void resolveCon( bool success , const Address &address , std::string reason ) ;

private:
        ClientResolver( const ClientResolver & ) ;
        void operator=( const ClientResolver & ) ;
} ;

class GNet::SimpleClient : public GNet::EventHandler , public GNet::Connection , public GNet::SocketProtocolSink 
{
public:
        enum ConnectStatus { Success , Failure , Retry , ImmediateSuccess } ;
    enum State { Idle , Resolving , Connecting , Connected , Socksing } ;
        G_EXCEPTION( DnsError , "dns error" ) ;
        G_EXCEPTION( ConnectError , "connect failure" ) ;
        G_EXCEPTION( SocksError , "socks error" ) ;
        G_EXCEPTION( NotConnected , "socket not connected" ) ;
        typedef std::string::size_type size_type ;

        SimpleClient( const ResolverInfo & remote_info ,
                const Address & local_address = Address(0U) , 
                bool privileged = false ,
                bool sync_dns = synchronousDnsDefault() ,
                unsigned int secure_connection_timeout = 0U ) ;

        void connect() ;

        bool connected() const ;

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

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

        virtual std::string peerCertificate() const ;

        ResolverInfo resolverInfo() const ;

        static bool synchronousDnsDefault() ;

        void updateResolverInfo( const ResolverInfo & ) ;

        virtual void readEvent() ; 

        virtual void writeEvent() ;

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

protected:
        virtual ~SimpleClient() ;

        StreamSocket & socket() ;

        const StreamSocket & socket() const ;

        virtual void onConnect() = 0 ;

        virtual void onConnectImp() ;

        virtual void onSendComplete() = 0 ;

        virtual void onSendImp() ;

        void sslConnect() ;

        static bool canRetry( const std::string & reason ) ;

        std::string logId() const ;

private:
        friend class ClientResolver ;
        void resolveCon( bool , const Address & , std::string ) ;

private:
        SimpleClient( const SimpleClient& ) ; // not implemented
        void operator=( const SimpleClient& ) ; // not implemented
        void close() ;
        static unsigned int getRandomPort() ;
        bool startConnecting() ;
        bool localBind( Address ) ;
        ConnectStatus connectCore( Address remote_address , std::string *error_p ) ;
        void setState( State ) ;
        void immediateConnection() ;
        void sendSocksRequest() ;
        bool readSocksResponse() ;
        void logFlowControlAsserted() const ;
        void logFlowControlReleased() const ;

private:
        std::auto_ptr<ClientResolver> m_resolver ;
        std::auto_ptr<StreamSocket> m_s ;
        std::auto_ptr<SocketProtocol> m_sp ;
        ResolverInfo m_remote ;
        Address m_local_address ;
        bool m_privileged ;
        State m_state ;
        bool m_sync_dns ;
        unsigned int m_secure_connection_timeout ;
} ;

#endif