/*
    Copyright (c) 20011 Hovanes Egiyan <hovanes@jlab.org>

    Permission is hereby granted, free of charge, to any person
    obtaining a copy of this software and associated documentation
    files (the "Software"), to deal in the Software without
    restriction, including without limitation the rights to use,
    copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following
    conditions:

    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
    OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
    OTHER DEALINGS IN THE SOFTWARE.

*/

#ifndef _BaseIUBuffer_HH_
#define _BaseIUBuffer_HH_

#include <map>
#include <deque>

#include "MtxLock.hh"

#include "BaseIUMessage.hh"

typedef map<string, map<int, deque<BaseIUMessage> > > msgMap;

class BaseIUBuffer : public msgMap {

  private:
  
  protected:

  
  public:
    BaseIUBuffer() {};
    virtual ~BaseIUBuffer() { ; }

    //! Define these methods two prevent creation of keys by mistake
    //! during operations of checking and comparing etc 
    virtual bool KeyExists( const string portName ) const ;
    virtual bool KeyExists( const string portName, const int addr ) const;

    //! Remove all messages from connection  portName and address addr
    //! Remove the address keys as well. The connection key is not removed .
    virtual void Clear( const string portName, const int addr );
    //! Remove all messages from connection  portName
    virtual void Clear( const string portName );

    //! Push a message into the deque for connection portName and address addr
    inline virtual void PushBack( const string portName, const int addr, BaseIUMessage& msg )
//    { if( this->KeyExists(portName,addr) ) (*this)[portName][addr].push_back( msg ); return; }
    { if( 1 ) (*this)[portName][addr].push_back( msg ); return; }
    
    //! Print content of the buffer into the stream
    virtual void Print( ostream& os ) const ;
};

//! Non-member function to print out BaseIUBuffer class through stream
ostream& operator<<( ostream& os, const BaseIUBuffer& buffer );

#endif // _BaseIUBuffer_HH_