//----------------------------------------------------------------------------------
// <copyright file="SSQEnqueueCmd.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 SSQEnqueueCmd, a queue-able item that executes the EnqueueMessage
//  on the controller.
// </summary>
//
// <owner>Mike Cookson</owner>
//----------------------------------------------------------------------------------

#ifndef __SSQEnqueueCmd_H__
#define __SSQEnqueueCmd_H__

#include "SSQClassConfig.h"
#include "LqrSMACByteArray.h"

namespace LiquidRobotics {

namespace SMACFramework {
	class CmdLineParser;
	class Logger;
}

namespace SimpleSBDQueue {

class SHARED_LIB_PUBLIC SSQEnqueueCmd : public SSQConcreteCmd
{
public:

	typedef LiquidRobotics::SMACFramework::ByteArray ByteArray;;
	typedef SSQConcreteCmd::CmdBasePtr CmdPtr;
	typedef LiquidRobotics::SMACFramework::CmdLineParser CmdLineParser;
	typedef LiquidRobotics::SMACFramework::Logger Logger;
	typedef SSQControllerBase0::ParsingContext ParsingContext;
    typedef SSQControllerBase0::PriorityType PriorityType;
    typedef SSQControllerBase0::SenderIDType SenderIDType;
    typedef SSQControllerBase0::SenderTransactionType SenderTransactionType;
    typedef SSQControllerBase0::QueuePosition QueuePosition;
    typedef SSQControllerBase0::TTLType TTLType;

	SSQEnqueueCmd(TCon& _ctrl, const string& _cmd, Logger& _logger, bool _mbCheck,
        const ByteArray& _message, const PriorityType _priority, const SenderIDType _senderID,
        const SenderTransactionType _senderTrans, const QueuePosition _queuePos,
        const TTLType _ttl);
	virtual ~SSQEnqueueCmd();

	// this method is called by the background thread to execute the command
	virtual void Execute();

	// parse the command
	static CmdPtr Parse(const string& arg1, const string& arg2, bool mbCheck, TCon& ctrl, const CmdLineParser& parser, ParsingContext& context, Logger& logger);

private:

	TCon& ctrl;
	const string cmd;
	Logger& logger;
    const bool mbCheck;
    const ByteArray message;
    const PriorityType priority;
    const SenderIDType senderID;
    const SenderTransactionType senderTrans;
    const QueuePosition queuePos;
    const TTLType ttl;
};

}
}

#endif
