//--------------------------------------------------------------------------------
// <copyright file="LqrSMACPseudoTerminalMaster.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 the PseudoTerminalMaster class, a controller class that opens
//   a psuedo-terminal and optionally soft-links it to a well-known location.  The
//   controller object can be treated as a ISerialPort.
// </summary>
//
// <owner>Mike Cookson</owner>
//--------------------------------------------------------------------------------

#include "LqrSMACSerialPort.h"
#include <string>

namespace LiquidRobotics {
namespace SMACFramework {

class SHARED_LIB_PUBLIC PseudoTerminalMaster : public SerialPort
{
public:

	typedef std::string string;

	PseudoTerminalMaster(const string& _wellKnownName, bool _keepSlaveOpen = true);
	PseudoTerminalMaster(const string& _wellKnownName, Logger& _logger, bool _keepSlaveOpen = true);

	virtual ~PseudoTerminalMaster();

	inline const string& GetWellKnownName() const
	{
		return wellKnownName;
	}

	inline string GetPseudoTerminalName() const
	{
		return psuedoTerminalName;
	}

	inline int GetSlaveFD() const
	{
		return slaveFD;
	}

	inline const string& GetSlaveName() const
	{
		return slaveName;
	}

protected:

	virtual int DoClosePort(int _fd);
	virtual int DoOpenPort(const string& _portName);

private:

	void CloseSlave(bool forceClose = true);

	const string wellKnownName;
	string psuedoTerminalName;
	const bool keepSlaveOpen;
	int slaveFD;
	string slaveName;
};

}
}
