peerenvironment.h

/*
    This file is part of the Kapotah project.
    Copyright (C) 2011 Shantanu Tushar <shaan7in@gmail.com>
    Copyright (C) 2011 Sudhendu Kumar <sudhendu.kumar.roy@gmail.com>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program 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/>.
*/

#ifndef KAPOTAH_PEERENVIRONMENT_H
#define KAPOTAH_PEERENVIRONMENT_H

#include <QString>

namespace Kapotah
{

    /**
     * \brief This class scans the peer's environment for useful data
     *
     * This class is currently used to deduce user's name from OS environment
     */
    class PeerEnvironment
    {
        public:
            /**
             * Used to get the user's namespace
             *
             * @return  user's name from OS environment
             */
            static QString getPeerName();
    };

}

#endif // KAPOTAH_PEERENVIRONMENT_H