//------------------------------------------------------------------------------
// <copyright file="ConnectionManagerRUDICS.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>
// 	Declaration of ConnectionManagerRUDICS class, which
//  manages a channel over RUDICS.
// </summary>
//
// <owner>Arash Ushani</owner>
//------------------------------------------------------------------------------

#ifndef __ConnectionManagerRUDICS_H__
#define __ConnectionManagerRUDICS_H__

#include "ConnectionManagerChannel.h"
#include "PPPHost.h"
#include "PPPHostSettings.h"
#include "LqrSMACWaitableThreadSafeQueue.h"

namespace LiquidRobotics {
namespace ConnectionManager {

class SHARED_LIB_PUBLIC ConnectionManagerRUDICS :
public ConnectionManagerChannel
{
public:

	typedef LiquidRobotics::PPPHostLib::PPPHost PPPHost;
	typedef LiquidRobotics::PPPHostLib::PPPHost::Ptr PPPHostPtr;
	typedef LiquidRobotics::PPPHostLib::PPPHostSettings PPPHostSettings;
	typedef LiquidRobotics::PPPHostLib::PPPHost::ConnectionStatus ConnectionStatus;

	ConnectionManagerRUDICS(const ConnectionManagerChannelSettings& _settings, Logger::Ptr _logger);
	ConnectionManagerRUDICS(const ConnectionManagerRUDICS& rhs);

	bool ChannelOn();
	bool ChannelOff();

	struct QueueEntry
	{
		enum Type
		{
			UNSPECIFIED = -1,
			ABORT_DELAY,
			CONNECTION_STATE_CHANGE,
			SHUT_DOWN,
			SCP_EXITED,
			SCP_OUTPUT,
			USER_OUTPUT,
			USER_PROGRAM_EXITED
		};

		QueueEntry(Type _type)
		: type(_type)
		{
		}

		QueueEntry(Type _type, const ConnectionStatus& _newStatus)
		: type(_type)
		, newStatus(_newStatus)
		{
		}

		QueueEntry(Type _type, const int& _resultCode)
		: type(_type)
		, resultCode(_resultCode)
		{
		}

		QueueEntry(Type _type, const string& _line)
		: type(_type)
		, line(_line)
		{
		}

		Type type;
		ConnectionStatus newStatus;						// the new connection status
		int resultCode;									// exit code from process
		string line;									// line received
	};

private:

	typedef LiquidRobotics::SMACFramework::WaitableThreadSafeQueue<QueueEntry> QueueType;

	void PPPHostCallback(PPPHost& sender, ConnectionStatus connectionStatus);

	ScopedConnectionPtr pppConnection;
	PPPHostPtr pppHost;
	QueueType queue;
};


}
}

BOOST_CLASS_VERSION(LiquidRobotics::ConnectionManager::ConnectionManagerRUDICS, 1)

#endif
