diff options
author | Mikkel Krautz <mikkel@krautz.dk> | 2016-02-20 18:18:54 +0300 |
---|---|---|
committer | Mikkel Krautz <mikkel@krautz.dk> | 2016-05-08 17:45:52 +0300 |
commit | 9128351b5c6028ead9a9855690dc0b10fbc4fb31 (patch) | |
tree | f7d7bf7df817a402d63900eeeb6bae6ce8d77cba /src/murmur/Server.h | |
parent | c7cd28b469c22e950c167af0b4353a69c644c163 (diff) |
grpc: rename GRPC-specific Server::setChannelState method, and add docs.
Diffstat (limited to 'src/murmur/Server.h')
-rw-r--r-- | src/murmur/Server.h | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/src/murmur/Server.h b/src/murmur/Server.h index 3542bc292..651dfee17 100644 --- a/src/murmur/Server.h +++ b/src/murmur/Server.h @@ -332,7 +332,20 @@ class Server : public QThread { void contextAction(const User *, const QString &, unsigned int, int); public: void setUserState(User *p, Channel *parent, bool mute, bool deaf, bool suppressed, bool prioritySpeaker, const QString& name = QString(), const QString &comment = QString()); - bool setChannelState(const MumbleProto::ChannelState &cs, QString &err); + + /// Update a channel's state using the ChannelState protobuf message and + /// broadcast the changes appropriately to the server. On return, if + /// err is non-empty, the operation failed, and err contains a description + /// of the error. + /// + /// This method is equivalent to the logic that happens in + /// Server::msgChannelState when a ChannelState message is recieved from + /// a user. However, this method doesn't do permissions checking. + /// + /// This method is used by the gRPC implementation to perform channel + /// state changes. + bool setChannelStateGRPC(const MumbleProto::ChannelState &cs, QString &err); + bool setChannelState(Channel *c, Channel *parent, const QString &qsName, const QSet<Channel *> &links, const QString &desc = QString(), const int position = 0); /// Send a text message using the TextMessage protobuf message |