libzmq/src/metadata.hpp

/*
    Copyright (c) 2007-2014 Contributors as noted in the AUTHORS file

    This file is part of 0MQ.

    0MQ 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.

    0MQ 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef __ZMQ_METADATA_HPP_INCLUDED__
#define __ZMQ_METADATA_HPP_INCLUDED__

#include <map>
#include <string>

#include "atomic_counter.hpp"

namespace zmq
{
    class metadata_t
    {
        public:

            typedef std::map <std::string, const std::string> dict_t;

            metadata_t (const dict_t &dict);
            virtual ~metadata_t ();

            //  Returns pointer to property value or NULL if
            //  property is not found.
            virtual const char *get (const std::string &property) const;

            virtual void add_ref ();

            //  Drop reference. Returns true iff the reference
            //  counter drops to zero.
            virtual bool drop_ref ();

        private:

            //  Reference counter.
            atomic_counter_t ref_cnt;

            //  Dictionary holding metadata.
            const dict_t dict;
    };

}

#endif