mama/MamaSymbolList.h

/* $Id$
 *
 * OpenMAMA: The open middleware agnostic messaging API
 * Copyright (C) 2011 NYSE Technologies, Inc.
 *
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

#ifndef MAMA_SYMBOL_LIST_CPP_H__
#define MAMA_SYMBOL_LIST_CPP_H__

#include <mama/mamacpp.h>
#include <mama/MamaSymbolListMember.h>
#include <mama/MamaSymbolListHandlerTypes.h>

namespace Wombat 
{

    class MAMACPPExpDLL MamaSymbolList
    {
    public:
     
        MamaSymbolList ();
        virtual ~MamaSymbolList ();

        void addMembershipHandler (MamaSymbolListMembershipHandler*  handler);

        void addMember (MamaSymbolListMember*  member);

        MamaSymbolListMember*  findMember (const char*            symbol,
                                           const char *           source,
                                           mamaTransport          transport);

        MamaSymbolListMember* removeMember (const char*             symbol,
                                            const char*             source,
                                            mamaTransport           transport);

        void removeMember (MamaSymbolListMember& member);

        void removeMemberAll (void);

        void clear ();
        
        void dump ();

        bool empty () const;

        mama_size_t size () const;

        void setClosure (void* closure);

        void* getClosure () const;

        void iterate (MamaSymbolListIteratorHandler&  handler,
                      void*                           iterateClosure = NULL);


        mamaSymbolList getCValue ();

        const mamaSymbolList getCValue () const;

        struct MamaSymbolListImpl;
        MamaSymbolListImpl* myPimpl;

    protected:
        mamaSymbolList  myList;
    };

} // namespace Wombat

#endif // MAMA_SYMBOL_LIST_CPP_H__