//------------------------------------------------------------------------------
// <copyright file="ChannelRequestEvent.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 ChannelRequestEvent class, which models an event
//   that requests a channel connection or cancels an earlier request
// </summary>
//
// <owner>Arash Ushani</owner>
//------------------------------------------------------------------------------

#ifndef __ChannelRequestEvent_H__
#define __ChannelRequestEvent_H__

#include "EventBase.h"
#include <string>
#include <vector>
#include <sys/time.h>

namespace LiquidRobotics {
namespace EventLib {

class SHARED_LIB_PUBLIC ChannelRequestEvent : public EventBase
{
public:

	typedef CORBA::Any CORBAAny;
	typedef CORBA::Any_var CORBAAnyVar;
	typedef boost::shared_ptr<ChannelRequestEvent> Ptr;

	ChannelRequestEvent(IObjectBroker& _broker);
	ChannelRequestEvent(const EventSettings& _eventSettings, IObjectBroker& _broker);
	ChannelRequestEvent(const EventName& _eventName, const EventType& _eventType, IObjectBroker& _broker);
	ChannelRequestEvent(const EventName& _eventName, const EventType& _eventType, const IOR& _senderIOR, IObjectBroker& _broker);
	ChannelRequestEvent(const ChannelRequestEvent& other);

	virtual ostream& Describe(ostream& stm) const;
	virtual IEventBase::Ptr Duplicate() const;

	uint8_t GetProtocolRevision() const;
	void SetProtocolRevision(uint8_t val);

	bool IsActiveRequest() const;
	void SetActiveRequest();

	bool IsCancelRequest() const;
	void SetCancelRequest();

private:

	enum RequestType
	{
		ACTIVE_REQUEST = 1,
		CANCEL_REQUEST = 0
	};

	static const PropertyNameType protocolRevisionTag;
	static const PropertyNameType requestTypeTag;
};

}
}

#endif
