//-----------------------------------------------------------------------------------
// <copyright file="LqrSMACAddressableMessageServiceBase.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>
//	Virtual definitions for a service that sends and receives messages based on
//	the address
// </summary>
//
// <owner>Mike Cookson</owner>
//-----------------------------------------------------------------------------------

#ifndef __LqrSMACAddressableMessageServiceBase_H__
#define __LqrSMACAddressableMessageServiceBase_H__

#include "LqrSMACDeclareException.h"
#include "LqrSMACSharedLib.h"
#include <boost/signals2.hpp>
#include <boost/shared_ptr.hpp>
#include <stdexcept>
#include <string>
#include <stdint.h>

namespace LiquidRobotics {
namespace SMACFramework {

class ByteArray;

class SHARED_LIB_PUBLIC AddressableMessageServiceBase
{
public:

	enum NotifyType
	{
		NT_ENCRYPTED,							// encrypted data received
		NT_ENQUEUED,							// message has been enqueued and intermediary
		NT_PRIMARY,								// primary/command message received
		NT_SECONDARY,							// secondary/acknowledge message received
		NT_TRANSMITTED,							// intermediary has been transmitted
	};

	typedef std::string string;
	static string ToString(NotifyType notify);

	DECLARE_EXCEPTION(TransmitTimeout, std::runtime_error);

	typedef uint16_t BoardAddress;
	typedef uint16_t HandshakeTransactionID;
	typedef boost::shared_ptr<ByteArray> ByteArrayPtr;

	struct NotificationItem
	{
		NotifyType notifyType;					// type of notification
		BoardAddress recipientID;				// ID of receiver
		BoardAddress senderID;					// ID of transmitter
		HandshakeTransactionID handshakeID;		// handshake ID assigned during transmission
		ByteArrayPtr data;						// raw data being passed
		bool requestAck;						// true if ack requested, false if not
	};

	typedef boost::shared_ptr<NotificationItem>  NotificationItemPtr;

	typedef boost::signals2::scoped_connection ScopedConnection;
	typedef boost::shared_ptr<ScopedConnection> ScopedConnectionPtr;
	typedef boost::signals2::signal<
		void (AddressableMessageServiceBase& sender, NotificationItemPtr notification)> NotifySignalType;

	virtual ~AddressableMessageServiceBase();
	virtual ScopedConnectionPtr SubscribeDiscarded(NotifySignalType::slot_type callback);
	virtual ScopedConnectionPtr SubscribeReceive(NotifySignalType::slot_type callback);
	virtual HandshakeTransactionID Transmit(BoardAddress remoteID, ByteArrayPtr data, bool requestAck = true) = 0;

protected:

	NotifySignalType discardedSignal;
	NotifySignalType notifySignal;
};

}
}

#endif
