OpenWalnut  1.4.0
WSharedObjectTicketWrite.h
00001 //---------------------------------------------------------------------------
00002 //
00003 // Project: OpenWalnut ( http://www.openwalnut.org )
00004 //
00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
00006 // For more information see http://www.openwalnut.org/copying
00007 //
00008 // This file is part of OpenWalnut.
00009 //
00010 // OpenWalnut is free software: you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as published by
00012 // the Free Software Foundation, either version 3 of the License, or
00013 // (at your option) any later version.
00014 //
00015 // OpenWalnut is distributed in the hope that it will be useful,
00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018 // GNU Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public License
00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
00022 //
00023 //---------------------------------------------------------------------------
00024 
00025 #ifndef WSHAREDOBJECTTICKETWRITE_H
00026 #define WSHAREDOBJECTTICKETWRITE_H
00027 
00028 #include <boost/shared_ptr.hpp>
00029 
00030 #include "WCondition.h"
00031 #include "WSharedObjectTicket.h"
00032 
00033 /**
00034  * Class which represents granted access to a locked object. It contains a reference to the object and a lock. The lock is freed after the ticket
00035  * has been destroyed. This class especially implements the exclusive (write) lock.
00036  */
00037 template < typename Data >
00038 class WSharedObjectTicketWrite: public WSharedObjectTicket< Data >
00039 {
00040 // the shared object class needs protected access to create new instances
00041 friend class WSharedObject< Data >;
00042 public:
00043     /**
00044      * Destroys the ticket and releases the lock.
00045      */
00046     virtual ~WSharedObjectTicketWrite()
00047     {
00048         // explicitly unlock to ensure the WSharedObjectTicket destructor can call the update callback AFTER the lock has been released
00049         unlock();
00050     };
00051 
00052     /**
00053      * Returns the protected data. As long as you own the ticket, you are allowed to use it.
00054      *
00055      * \return the data
00056      */
00057     Data& get() const
00058     {
00059         return WSharedObjectTicket< Data >::m_data;
00060     };
00061 
00062 protected:
00063     /**
00064      * Create a new instance. It is protected to avoid someone to create them. It locks the mutex for write.
00065      *
00066      * \param data the data to protect
00067      * \param mutex the mutex used to lock
00068      * \param condition a condition that should be fired upon unlock. Can be NULL.
00069      */
00070     WSharedObjectTicketWrite( Data& data, boost::shared_ptr< boost::shared_mutex > mutex, boost::shared_ptr< WCondition > condition ): // NOLINT
00071         WSharedObjectTicket< Data >( data, mutex, condition ),
00072         m_lock( boost::unique_lock< boost::shared_mutex >( *mutex ) )
00073     {
00074     };
00075 
00076     /**
00077      * The lock.
00078      */
00079     boost::unique_lock< boost::shared_mutex > m_lock;
00080 
00081     /**
00082      * Unlocks the mutex.
00083      */
00084     virtual void unlock()
00085     {
00086         m_lock.unlock();
00087     }
00088 
00089 private:
00090 };
00091 
00092 #endif  // WSHAREDOBJECTTICKETWRITE_H
00093