//------------------------------------------------------------------------------
// Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@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_MESSAGE_HH__
#define __XRD_CL_MESSAGE_HH__

#include "XrdCl/XrdClBuffer.hh"
#include "XrdOuc/XrdOucUtils.hh"
#include "XrdOuc/XrdOucPrivateUtils.hh"

namespace XrdCl
{
  //----------------------------------------------------------------------------
  //! The message representation used throughout the system
  //----------------------------------------------------------------------------
  class Message: public Buffer
  {
    public:
      //------------------------------------------------------------------------
      //! Constructor
      //------------------------------------------------------------------------
      Message( uint32_t size = 0 ):
        Buffer( size ), pIsMarshalled( false ), pSessionId(0), pVirtReqID( 0 )
      {
        if( size )
          Zero();
      }

      //------------------------------------------------------------------------
      //! Move Constructor
      //------------------------------------------------------------------------
      Message( Message && msg ):
        Buffer( std::move( msg ) ), pIsMarshalled( msg.pIsMarshalled ),
        pSessionId( std::move( msg.pSessionId ) ), pVirtReqID( msg.pVirtReqID )
      {
      }

      //------------------------------------------------------------------------
      //! Move assignment operator
      //------------------------------------------------------------------------
      Message& operator=( Message && msg )
      {
        Steal( std::move( msg ) );
        pIsMarshalled = msg.pIsMarshalled;
        pSessionId = std::move( msg.pSessionId );
        pVirtReqID = msg.pVirtReqID;
        return *this;
      }

      //------------------------------------------------------------------------
      //! Destructor
      //------------------------------------------------------------------------
      virtual ~Message() {}

      //------------------------------------------------------------------------
      //! Check if the message is marshalled
      //------------------------------------------------------------------------
      bool IsMarshalled() const
      {
        return pIsMarshalled;
      }

      //------------------------------------------------------------------------
      //! Set the marshalling status
      //------------------------------------------------------------------------
      void SetIsMarshalled( bool isMarshalled )
      {
        pIsMarshalled = isMarshalled;
      }

      //------------------------------------------------------------------------
      //! Set the description of the message
      //------------------------------------------------------------------------
      void SetDescription( const std::string &description )
      {
        pDescription = description;
        pObfuscatedDescription = obfuscateAuth(description);
      }

      //------------------------------------------------------------------------
      //! Get the description of the message
      //------------------------------------------------------------------------
      const std::string &GetDescription() const
      {
        return pDescription;
      }

      //------------------------------------------------------------------------
      //! Get the description of the message with authz parameter obfuscated
      //------------------------------------------------------------------------
      const std::string & GetObfuscatedDescription() const
      {
        return pObfuscatedDescription;
      }

      //------------------------------------------------------------------------
      //! Set the session ID which this message is meant for
      //------------------------------------------------------------------------
      void SetSessionId( uint64_t sessionId )
      {
        pSessionId = sessionId;
      }

      //------------------------------------------------------------------------
      //! Get the session ID the message is meant for
      //------------------------------------------------------------------------
      uint64_t GetSessionId() const
      {
        return pSessionId;
      }

      //------------------------------------------------------------------------
      //! Set virtual request ID for the message
      //------------------------------------------------------------------------
      void SetVirtReqID( uint16_t virtReqID )
      {
        pVirtReqID = virtReqID;
      }

      //------------------------------------------------------------------------
      //! Get virtual request ID for the message
      //------------------------------------------------------------------------
      uint16_t GetVirtReqID() const
      {
        return pVirtReqID;
      }

    private:
      bool         pIsMarshalled;
      uint64_t     pSessionId;
      std::string  pDescription;
      uint16_t     pVirtReqID;
      std::string  pObfuscatedDescription;
  };
}

#endif // __XRD_CL_MESSAGE_HH__