summaryrefslogtreecommitdiffstats
path: root/src/chat-server/chatchannel.hpp
blob: 268f1355f4381817b7e08e5d2edf419eb7e35663 (plain)
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
 *  The Mana World Server
 *  Copyright 2004 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_CHATCHANNEL_H_
#define _TMWSERV_CHATCHANNEL_H_

#include <string>
#include <vector>

class ChatChannel {
 public:
    typedef std::vector< std::string > ChannelUsers;

    /**
     * Constructors
     */
    ChatChannel(const std::string &channelName,
                const std::string &channelAnnouncement,
                const std::string &channelPassword,
                bool channelPrivacy);

    /**
     * Destructor
     */
    ~ChatChannel();

    /**
     * Get the name of the channel
     */
    const std::string& getName() const;

    /**
     * Get the Announcement string of the channel
     */
    const std::string& getAnnouncement() const;

    /**
     * Get the password of the channel
     */
    const std::string& getPassword() const;

    /**
     * Get the password of the channel
     */
    bool getPrivacy() const;

    /**
     * Set the name of the channel
     */
    void setName(const std::string &channelName);

    /**
     * Set the Announcement string of the channel
     */
    void setAnnouncement(const std::string &channelAnnouncement);

    /**
     * Set the password of the channel
     */
    void setPassword(const std::string &channelPassword);

    /**
     * Get the list of the users registered in the channel
     */
    ChannelUsers const &getUserList() const;

    /**
     * Add a user in the channel
     */
    bool addUserInChannel(std::string const &);

    /**
     * Remove a user from the channel.
     */
    bool removeUserFromChannel(std::string const &);

    /**
     * Empties a channel from its users (admin included).
     */
    void removeEveryUsersFromChannel();

 private:
    /**
     * The Channel's name.
     */
    std::string mChannelName;

    /**
     * The Channel's announcement.
     */
    std::string mChannelAnnouncement;

    /**
     * The Channel's password.
     */
    std::string mChannelPassword;

    /**
     * The registered user list
     */
    ChannelUsers mRegisteredUsers;

    /**
     * Whether the channel is private
     */
    bool mChannelPrivate;

};

#endif