//--------------------------------------------------------------------------------
// <copyright file="LqrSMACSignalSubscriber.h" company="LiquidRobotics">
//
// Copyright (c) 2014 Liquid Robotics, Inc.
//
// 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.
//
// This software is associated with a release.  Liquid Robotics makes no
// representation that the design, interfaces or component distribution will
// remain unchanged in future releases.
//
// </copyright>
//
// <summary>
//   Declarations for SignalSubscriber class, which provides a subscription action
//	 for the signal passed to the constructor; the subscription action returns the
//	 appropriate scoped connection pointer.
// </summary>
//
// <owner>Mike Cookson</owner>
//--------------------------------------------------------------------------------

#ifndef __LqrSMACSignalSubscriber_h__
#define __LqrSMACSignalSubscriber_h__

#include "LqrSMACLockableConcept.h"
#include "LqrSMACSharedLib.h"
#include "LqrSMACScopedConnection.h"

namespace LiquidRobotics {
namespace SMACFramework {

template<typename TSignal>
class SHARED_LIB_PUBLIC SignalSubscriber : public boost::noncopyable
{
public:

	typedef SignalSubscriber<TSignal> SignalSubscriberT;
	typedef boost::shared_ptr<SignalSubscriberT> Ptr;
	SCOPED_CONNECTION_TYPEDEFS();
	typedef typename TSignal::slot_type SignalSlot;
	typedef std::string string;

	SignalSubscriber(TSignal& _sig, LockableConceptMutex& _mut)
	: sig(_sig)
	, mut(_mut)
	{
	}

	void Release(ScopedConnectionPtr& subscription)
	{
		ILockableConceptLock lock(mut);
		subscription.reset();
	}

	ScopedConnectionPtr Subscribe(SignalSlot slot)
	{
		return GenericSubscribe(sig, slot);
	}

private:

	TSignal& sig;
	LockableConceptMutex& mut;
};

}
}

#endif
