PluginFrame.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_CORE_PLUGINFRAME_H
#define ZYPP_CORE_PLUGINFRAME_H
 
#include <iosfwd>
#include <string>
#include <map>
 
#include <zypp/base/PtrTypes.h>
 
#include <zypp-core/ByteArray.h>
#include <zypp-core/rpc/PluginFrameException.h>

namespace zypp
{ 

  class ZYPP_API PluginFrame
  {
    friend std::ostream & operator<<( std::ostream & str, const PluginFrame & obj );
    friend bool operator==( const PluginFrame & lhs, const PluginFrame & rhs );
 
    using HeaderInitializerList = const std::initializer_list<std::pair<std::string, std::string>> &;
 
    public:
      static const std::string & ackCommand();
      static const std::string & errorCommand();
      static const std::string & enomethodCommand();
      static const std::string &contentLengthHeader();
 
    public:
      using Exception = PluginFrameException;

      PluginFrame();

      PluginFrame( const std::string & command_r );

      PluginFrame(const std::string & command_r, std::string body_r );

      PluginFrame(const std::string & command_r, ByteArray body_r );

      PluginFrame( const std::string & command_r, HeaderInitializerList contents_r );

      PluginFrame(const std::string & command_r, ByteArray body_r, HeaderInitializerList contents_r );

      PluginFrame( std::istream & stream_r );
 
    public:
      bool empty() const;

      explicit operator bool() const
      { return !empty(); }
 
    public:
      const std::string & command() const;

      void setCommand( const std::string & command_r );

      bool isAckCommand() const
      { return command() == ackCommand(); }

      bool isErrorCommand() const
      {return command() == errorCommand(); }

      bool isEnomethodCommand() const
      {return command() == enomethodCommand(); }

      const ByteArray & body() const;

      ByteArray & bodyRef();

      void setBody( const std::string & body_r );

      void setBody( const ByteArray & body_r );

      void setBody( ByteArray && body_r );
 
    public:
      using HeaderList = std::multimap<std::string, std::string>;

      using HeaderListIterator = HeaderList::const_iterator;
 
    private:
      HeaderList & headerList();
 
    public:
      const HeaderList & headerList() const;

      bool headerEmpty() const
      { return headerList().empty(); }

      unsigned headerSize() const
      { return headerList().size(); }

      HeaderListIterator headerBegin() const
      { return headerList().begin(); }

      HeaderListIterator headerEnd() const
      { return headerList().end(); }

      void headerClear()
      { headerList().clear(); }
 

      bool hasKey( const std::string & key_r ) const
      { return ! keyEmpty( key_r ); }

      bool keyEmpty( const std::string & key_r ) const
      { return headerList().find( key_r ) == headerEnd(); }

      bool keySize( const std::string & key_r ) const
      { return headerList().count( key_r ); }

      HeaderListIterator keyBegin( const std::string & key_r ) const
      { return headerList().lower_bound( key_r ); }

      HeaderListIterator keyEnd( const std::string & key_r ) const
      { return headerList().upper_bound( key_r ); }
 

      const std::string & getHeader( const std::string & key_r ) const;

      const std::string & getHeader( const std::string & key_r, const std::string & default_r ) const;

      const std::string & getHeaderNT( const std::string & key_r, const std::string & default_r = std::string() ) const;

      void setHeader( const std::string & key_r, const std::string & value_r = std::string() );

      void setHeader( HeaderInitializerList contents_r )
      { headerList().clear(); addHeader( contents_r ); }

      void addHeader( const std::string & key_r, const std::string & value_r = std::string() );
      void addHeader( HeaderInitializerList contents_r );

      void addRawHeader ( const ByteArray &header );

      void clearHeader( const std::string & key_r );
 
    public:
      std::ostream & writeTo( std::ostream & stream_r ) const;

      static std::ostream & writeTo( std::ostream & stream_r, const PluginFrame & frame_r )
      { return frame_r.writeTo( stream_r ); }

      std::istream & readFrom( std::istream & stream_r )
      { *this = PluginFrame( stream_r ); return stream_r; }

      static std::istream & readFrom( std::istream & stream_r, PluginFrame & frame_r )
      { frame_r = PluginFrame( stream_r ); return stream_r; }
 
    public:
      struct Impl;
    private:
      RWCOW_pointer<Impl> _pimpl;
  };

  std::ostream & operator<<( std::ostream & str, const PluginFrame & obj );

  inline std::ostream & dumpOn( std::ostream & str, const PluginFrame & obj )
  { if ( str ) try { PluginFrame::writeTo( str, obj ); } catch(...){}; return str; }

  inline std::istream & operator>>( std::istream & str, PluginFrame & obj )
  { return PluginFrame::readFrom( str, obj ); }

  bool operator==( const PluginFrame & lhs, const PluginFrame & rhs );

  inline bool operator!=( const PluginFrame & lhs, const PluginFrame & rhs )
  { return( ! operator==( lhs, rhs ) ); }

} // namespace zypp
#endif // ZYPP_CORE_PLUGINFRAME_H