XrdClTls.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
// Author: Michal Simon <simonm@cern.ch>
//------------------------------------------------------------------------------
// XRootD is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// XRootD 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 Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//------------------------------------------------------------------------------
 
#ifndef __XRD_CL_TLS_HH__
#define __XRD_CL_TLS_HH__
 
#include <memory>
 
#include "XrdTls/XrdTlsSocket.hh"
 
#include "XrdCl/XrdClXRootDResponses.hh"
#include "XrdCl/XrdClAsyncSocketHandler.hh"
 
namespace XrdCl
{
  class Socket;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class Tls
  {
    public:
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Tls( Socket *socket, AsyncSocketHandler *socketHandler );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ~Tls()
      {
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Connect( const std::string &thehost, XrdNetAddrInfo *netInfo );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Read( char *buffer, size_t size, int &bytesRead );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus ReadV( iovec *iov, int iocnt, int &bytesRead );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Send( const char *buffer, size_t size, int &bytesWritten );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Shutdown();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      uint8_t MapEvent( uint8_t event );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static void ClearErrorQueue();
 
    private:
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      enum TlsHSRevert{ None, ReadOnWrite, WriteOnRead };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus ToStatus( XrdTls::RC rc );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Socket                       *pSocket;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      std::unique_ptr<XrdTlsSocket> pTls;
 
      //------------------------------------------------------------------------
      // In case during TLS hand-shake WantRead has been returned on write or
      // WantWrite has been returned on read we need to flip the following events.
      //
      // None        : all events should be processed normally
      // ReadOnWrite : on write event the OnRead routines should be called
      // WriteOnRead : on read event the OnWrite routines should be called
      //------------------------------------------------------------------------
      TlsHSRevert                   pTlsHSRevert;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      AsyncSocketHandler           *pSocketHandler;
  };
}
 
#endif // __XRD_CL_TLS_HH__