summaryrefslogtreecommitdiff
path: root/src/utils/tokendispenser.hpp
blob: a6f0b3eed8d1267a1ecccd880b2a703473096fe6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/*
 *  The Mana World Server
 *  Copyright 2007 The Mana World Development Team
 *
 *  This file is part of The Mana World.
 *
 *  The Mana World  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 2 of the License, or any later version.
 *
 *  The Mana  World 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 The Mana  World; if not, write to the  Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 *  $Id$
 */

#ifndef _TMWSERV_TOKENDISPENSER_HPP
#define _TMWSERV_TOKENDISPENSER_HPP

#define MAGIC_TOKEN_LENGTH 32

#include <string>

namespace utils
{
    /**
     * \brief Returns a magic_token.
     *
     * The tokens are used for spanning a user's session across multiple
     * servers.
     * NOTE: Uniqueness is not guaranteed, store the account- or characterId
     *       with the token if that is an issue.
     * NOTE: Not passed-by-reference by design.
     * NOTE: Store the token in a variable in this namespace if you want to
     *       avoid 1 copy operation per use.
     */
    std::string getMagicToken();

} // namespace utils

#endif // _TMWSERV_TOKENDISPENSER_HPP