barrier/src/lib/synergy/XSynergy.h

/*
 * synergy -- mouse and keyboard sharing utility
 * Copyright (C) 2012 Synergy Si Ltd.
 * Copyright (C) 2002 Chris Schoeneman
 * 
 * This package is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * found in the file LICENSE that should have accompanied this file.
 * 
 * This package is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include "base/XBase.h"

//! Generic synergy exception
XBASE_SUBCLASS(XSynergy, XBase);

//! Client error exception
/*!
Thrown when the client fails to follow the protocol.
*/
XBASE_SUBCLASS_WHAT(XBadClient, XSynergy);

//! Incompatible client exception
/*!
Thrown when a client attempting to connect has an incompatible version.
*/
class XIncompatibleClient : public XSynergy {
public:
	XIncompatibleClient(int major, int minor);

	//! @name accessors
	//@{

	//! Get client's major version number
	int					getMajor() const throw();
	//! Get client's minor version number
	int					getMinor() const throw();

	//@}

protected:
	virtual String		getWhat() const throw();

private:
	int					m_major;
	int					m_minor;
};

//! Client already connected exception
/*!
Thrown when a client attempting to connect is using the same name as
a client that is already connected.
*/
class XDuplicateClient : public XSynergy {
public:
	XDuplicateClient(const String& name);
	virtual ~XDuplicateClient() _NOEXCEPT { }

	//! @name accessors
	//@{

	//! Get client's name
	virtual const String&
						getName() const throw();

	//@}

protected:
	virtual String		getWhat() const throw();

private:
	String				m_name;
};

//! Client not in map exception
/*!
Thrown when a client attempting to connect is using a name that is
unknown to the server.
*/
class XUnknownClient : public XSynergy {
public:
	XUnknownClient(const String& name);
	virtual ~XUnknownClient() _NOEXCEPT { }

	//! @name accessors
	//@{

	//! Get the client's name
	virtual const String&
						getName() const throw();

	//@}

protected:
	virtual String		getWhat() const throw();

private:
	String				m_name;
};

//! Generic exit eception
/*!
Thrown when we want to abort, with the opportunity to clean up. This is a 
little bit of a hack, but it's a better way of exiting, than just calling 
exit(int).
*/
class XExitApp : public XSynergy {
public:
	XExitApp(int code);
	virtual ~XExitApp() _NOEXCEPT { }

	//! Get the exit code
	int getCode() const throw();

protected:
	virtual String	getWhat() const throw();
	
private:
	int	m_code;
};