gsocketprotocol.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_SOCKET_PROTOCOL_H
#define G_SOCKET_PROTOCOL_H

#include "gdef.h"
#include "gnet.h"
#include "gsocket.h"
#include "gexception.h"
#include <string>

namespace GNet
{
        class SocketProtocol ;
        class SocketProtocolImp ;
        class SocketProtocolSink ;
}

class GNet::SocketProtocol 
{
public:
        typedef SocketProtocolSink Sink ;
        G_EXCEPTION_CLASS( ReadError , "read error: disconnected" ) ;
        G_EXCEPTION( SendError , "peer disconnected" ) ;
        G_EXCEPTION( SecureConnectionTimeout , "secure connection timeout" ) ;

        SocketProtocol( EventHandler & , Sink & , StreamSocket & , unsigned int secure_connection_timeout ) ;

        ~SocketProtocol() ;

        void readEvent() ;

        bool writeEvent() ;

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

        static bool sslCapable() ;

        void sslConnect() ;

        void sslAccept() ;

        bool sslEnabled() const ;

        std::string peerCertificate() const ;

private:
        SocketProtocol( const SocketProtocol & ) ;
        void operator=( const SocketProtocol & ) ;

private:
        SocketProtocolImp * m_imp ;
} ;

class GNet::SocketProtocolSink 
{
public:
        virtual ~SocketProtocolSink() ;

protected:
        friend class SocketProtocolImp ;

        virtual void onData( const char * , std::string::size_type ) = 0 ;

        virtual void onSecure( const std::string & peer_certificate ) = 0 ;
} ;

#endif