mirror of
https://github.com/mumble-voip/mumble.git
synced 2025-10-26 11:19:16 +00:00
Use new slice doc syntax
This commit is contained in:
Thorvald Natvig
parent
136cac0cc2
commit
710dfb7a59
@ -1,8 +1,8 @@
|
||||
/**
|
||||
*
|
||||
* Information and control of the murmur server. Each server has
|
||||
* one [Meta] interface that controls global information, and
|
||||
* each virtual server has a [Server] interface.
|
||||
* one {@link Meta} interface that controls global information, and
|
||||
* each virtual server has a {@link Server} interface.
|
||||
*
|
||||
**/
|
||||
|
||||
@ -30,7 +30,7 @@ module Murmur
|
||||
bool selfMute;
|
||||
/** Is the user self-deafened? If true, this implies mute. */
|
||||
bool selfDeaf;
|
||||
/** Channel ID the user is in. Matches [Channel::id]. */
|
||||
/** Channel ID the user is in. Matches {@link Channel.id}. */
|
||||
int channel;
|
||||
/** The name of the user. */
|
||||
string name;
|
||||
@ -221,7 +221,7 @@ module Murmur
|
||||
};
|
||||
|
||||
exception MurmurException {};
|
||||
/** This is thrown when you specify an invalid session. This may happen if the user has disconnected since your last call to [Server::getUsers]. See [User::session] */
|
||||
/** This is thrown when you specify an invalid session. This may happen if the user has disconnected since your last call to {@link Server.getUsers}. See {@link User.session} */
|
||||
exception InvalidSessionException extends MurmurException {};
|
||||
/** This is thrown when you specify an invalid channel id. This may happen if the channel was removed by another provess. It can also be thrown if you try to add an invalid channel. */
|
||||
exception InvalidChannelException extends MurmurException {};
|
||||
@ -229,7 +229,7 @@ module Murmur
|
||||
exception InvalidServerException extends MurmurException {};
|
||||
/** This happens if you try to fetch user or channel state on a stopped server, if you try to stop an already stopped server or start an already started server. */
|
||||
exception ServerBootedException extends MurmurException {};
|
||||
/** This is thrown if [Server::start] fails, and should generally be the cause for some concern. */
|
||||
/** This is thrown if {@link Server.start} fails, and should generally be the cause for some concern. */
|
||||
exception ServerFailureException extends MurmurException {};
|
||||
/** This is thrown when you specify an invalid userid. */
|
||||
exception InvalidUserException extends MurmurException {};
|
||||
@ -246,16 +246,16 @@ module Murmur
|
||||
* Please note that all callbacks are done asynchronously; murmur does not wait for the callback to
|
||||
* complete before continuing processing.
|
||||
* Note that callbacks are removed when a server is stopped, so you should have a callback for
|
||||
* [MetaCallback::started] which calls [Server::addCallback].
|
||||
* {@link MetaCallback.started} which calls {@link Server.addCallback}.
|
||||
* @see MetaCallback
|
||||
* @see Server::addCallback
|
||||
* @see Server.addCallback
|
||||
*/
|
||||
interface ServerCallback {
|
||||
/** Called when a user connects to the server.
|
||||
* @param state State of connected user.
|
||||
*/
|
||||
idempotent void userConnected(User state);
|
||||
/** Called when a user disconnects from the server. The user has already been removed, so you can no longer use methods like [Server::getState]
|
||||
/** Called when a user disconnects from the server. The user has already been removed, so you can no longer use methods like {@link Server.getState}
|
||||
* to retrieve the user's state.
|
||||
* @param state State of disconnected user.
|
||||
*/
|
||||
@ -268,7 +268,7 @@ module Murmur
|
||||
* @param state State of new channel.
|
||||
*/
|
||||
idempotent void channelCreated(Channel state);
|
||||
/** Called when a channel is removed. The channel has already been removed, you can no longer use methods like [Server::getChannelState]
|
||||
/** Called when a channel is removed. The channel has already been removed, you can no longer use methods like {@link Server.getChannelState}
|
||||
* @param state State of removed channel.
|
||||
*/
|
||||
idempotent void channelRemoved(Channel state);
|
||||
@ -285,7 +285,7 @@ module Murmur
|
||||
/** Context for actions in the User menu. */
|
||||
const int ContextUser = 0x04;
|
||||
|
||||
/** Callback interface for context actions. You need to supply one of these for [Server::addContext].
|
||||
/** Callback interface for context actions. You need to supply one of these for {@link Server.addContext}.
|
||||
* If an added callback ever throws an exception or goes away, it will be automatically removed.
|
||||
* Please note that all callbacks are done asynchronously; murmur does not wait for the callback to
|
||||
* complete before continuing processing.
|
||||
@ -300,11 +300,11 @@ module Murmur
|
||||
idempotent void contextAction(string action, User usr, int session, int channelid);
|
||||
};
|
||||
|
||||
/** Callback interface for server authentication. You need to supply one of these for [Server::setAuthenticator].
|
||||
/** Callback interface for server authentication. You need to supply one of these for {@link Server.setAuthenticator}.
|
||||
* If an added callback ever throws an exception or goes away, it will be automatically removed.
|
||||
* Please note that unlike [ServerCallback] and [ServerContextCallback], these methods are called
|
||||
* Please note that unlike {@link ServerCallback} and {@link ServerContextCallback}, these methods are called
|
||||
* synchronously. If the response lags, the entire murmur server will lag.
|
||||
* Also note that, as the method calls are synchronous, making a call to [Server] or [Meta] will
|
||||
* Also note that, as the method calls are synchronous, making a call to {@link Server} or {@link Meta} will
|
||||
* deadlock the server.
|
||||
*/
|
||||
interface ServerAuthenticator {
|
||||
@ -357,7 +357,7 @@ module Murmur
|
||||
/** Callback interface for server authentication and registration. This allows you to support both authentication
|
||||
* and account updating.
|
||||
* You do not need to implement this if all you want is authentication, you only need this if other scripts
|
||||
* connected to the same server calls e.g. [Server::setTexture].
|
||||
* connected to the same server calls e.g. {@link Server.setTexture}.
|
||||
* Almost all of these methods support fall through, meaning murmur should continue the operation against its
|
||||
* own database.
|
||||
*/
|
||||
@ -397,7 +397,7 @@ module Murmur
|
||||
|
||||
/** Per-server interface. This includes all methods for configuring and altering
|
||||
* the state of a single virtual server. You can retrieve a pointer to this interface
|
||||
* from one of the methods in [Meta].
|
||||
* from one of the methods in {@link Meta}.
|
||||
**/
|
||||
["amd"] interface Server {
|
||||
/** Shows if the server currently running (accepting users).
|
||||
@ -444,12 +444,12 @@ module Murmur
|
||||
|
||||
/** Retrieve configuration item.
|
||||
* @param key Configuration key.
|
||||
* @return Configuration value. If this is empty, see [Meta::getDefaultConf]
|
||||
* @return Configuration value. If this is empty, see {@link Meta.getDefaultConf}
|
||||
*/
|
||||
idempotent string getConf(string key) throws InvalidSecretException;
|
||||
|
||||
/** Retrieve all configuration items.
|
||||
* @return All configured values. If a value isn't set here, the value from [Meta::getDefaultConf] is used.
|
||||
* @return All configured values. If a value isn't set here, the value from {@link Meta.getDefaultConf} is used.
|
||||
*/
|
||||
idempotent ConfigMap getAllConf() throws InvalidSecretException;
|
||||
|
||||
@ -459,7 +459,7 @@ module Murmur
|
||||
*/
|
||||
idempotent void setConf(string key, string value) throws InvalidSecretException;
|
||||
|
||||
/** Set superuser password. This is just a convenience for using [updateRegistration] on user id 0.
|
||||
/** Set superuser password. This is just a convenience for using {@link updateRegistration} on user id 0.
|
||||
* @param pw Password.
|
||||
*/
|
||||
idempotent void setSuperuserPassword(string pw) throws InvalidSecretException;
|
||||
@ -484,7 +484,7 @@ module Murmur
|
||||
idempotent ChannelMap getChannels() throws ServerBootedException, InvalidSecretException;
|
||||
|
||||
/** Fetch certificate of user. This returns the complete certificate chain of a user.
|
||||
* @param session Connection ID of user. See [User::session].
|
||||
* @param session Connection ID of user. See {@link User.session}.
|
||||
* @return Certificate list of user.
|
||||
*/
|
||||
idempotent CertificateList getCertificateList(int session) throws ServerBootedException, InvalidSessionException, InvalidSecretException;
|
||||
@ -500,20 +500,20 @@ module Murmur
|
||||
*/
|
||||
idempotent BanList getBans() throws ServerBootedException, InvalidSecretException;
|
||||
|
||||
/** Set all current IP bans on the server. This will replace any bans already present, so if you want to add a ban, be sure to call [getBans] and then
|
||||
/** Set all current IP bans on the server. This will replace any bans already present, so if you want to add a ban, be sure to call {@link getBans} and then
|
||||
* append to the returned list before calling this method.
|
||||
* @param bans List of bans.
|
||||
*/
|
||||
idempotent void setBans(BanList bans) throws ServerBootedException, InvalidSecretException;
|
||||
|
||||
/** Kick a user. The user is not banned, and is free to rejoin the server.
|
||||
* @param session Connection ID of user. See [User::session].
|
||||
* @param session Connection ID of user. See {@link User.session}.
|
||||
* @param reason Text message to show when user is kicked.
|
||||
*/
|
||||
void kickUser(int session, string reason) throws ServerBootedException, InvalidSessionException, InvalidSecretException;
|
||||
|
||||
/** Get state of a single connected user.
|
||||
* @param session Connection ID of user. See [User::session].
|
||||
* @param session Connection ID of user. See {@link User.session}.
|
||||
* @return State of connected user.
|
||||
* @see setState
|
||||
* @see getUsers
|
||||
@ -527,15 +527,15 @@ module Murmur
|
||||
idempotent void setState(User state) throws ServerBootedException, InvalidSessionException, InvalidChannelException, InvalidSecretException;
|
||||
|
||||
/** Send text message to a single user.
|
||||
* @param session Connection ID of user. See [User::session].
|
||||
* @param session Connection ID of user. See {@link User.session}.
|
||||
* @param text Message to send.
|
||||
* @see sendMessageChannel
|
||||
*/
|
||||
void sendMessage(int session, string text) throws ServerBootedException, InvalidSessionException, InvalidSecretException;
|
||||
|
||||
/** Check if user is permitted to perform action.
|
||||
* @param session Connection ID of user. See [User::session].
|
||||
* @param channelid ID of Channel. See [Channel::id].
|
||||
* @param session Connection ID of user. See {@link User.session}.
|
||||
* @param channelid ID of Channel. See {@link Channel.id}.
|
||||
* @param perm Permission bits to check.
|
||||
* @return true if any of the permissions in perm were set for the user.
|
||||
*/
|
||||
@ -547,7 +547,7 @@ module Murmur
|
||||
* @param action Action string, a unique name to associate with the action.
|
||||
* @param text Name of action shown to user.
|
||||
* @param cb Callback interface which will receive notifications.
|
||||
* @param ctx Context this should be used in. Needs to be one or a combination of [ContextServer], [ContextChannel] and [ContextUser].
|
||||
* @param ctx Context this should be used in. Needs to be one or a combination of {@link ContextServer}, {@link ContextChannel} and {@link ContextUser}.
|
||||
* @see removeContextCallback
|
||||
*/
|
||||
void addContextCallback(int session, string action, string text, ServerContextCallback *cb, int ctx) throws ServerBootedException, InvalidCallbackException, InvalidSecretException;
|
||||
@ -560,7 +560,7 @@ module Murmur
|
||||
void removeContextCallback(ServerContextCallback *cb) throws ServerBootedException, InvalidCallbackException, InvalidSecretException;
|
||||
|
||||
/** Get state of single channel.
|
||||
* @param channelid ID of Channel. See [Channel::id].
|
||||
* @param channelid ID of Channel. See {@link Channel.id}.
|
||||
* @return State of channel.
|
||||
* @see setChannelState
|
||||
* @see getChannels
|
||||
@ -574,19 +574,19 @@ module Murmur
|
||||
idempotent void setChannelState(Channel state) throws ServerBootedException, InvalidChannelException, InvalidSecretException;
|
||||
|
||||
/** Remove a channel and all its subchannels.
|
||||
* @param channelid ID of Channel. See [Channel::id].
|
||||
* @param channelid ID of Channel. See {@link Channel.id}.
|
||||
*/
|
||||
void removeChannel(int channelid) throws ServerBootedException, InvalidChannelException, InvalidSecretException;
|
||||
|
||||
/** Add a new channel.
|
||||
* @param name Name of new channel.
|
||||
* @param parent Channel ID of parent channel. See [Channel::id].
|
||||
* @param parent Channel ID of parent channel. See {@link Channel.id}.
|
||||
* @return ID of newly created channel.
|
||||
*/
|
||||
int addChannel(string name, int parent) throws ServerBootedException, InvalidChannelException, InvalidSecretException;
|
||||
|
||||
/** Send text message to channel or a tree of channels.
|
||||
* @param channelid Channel ID of channel to send to. See [Channel::id].
|
||||
* @param channelid Channel ID of channel to send to. See {@link Channel.id}.
|
||||
* @param tree If true, the message will be sent to the channel and all its subchannels.
|
||||
* @param text Message to send.
|
||||
* @see sendMessage
|
||||
@ -594,7 +594,7 @@ module Murmur
|
||||
void sendMessageChannel(int channelid, bool tree, string text) throws ServerBootedException, InvalidChannelException, InvalidSecretException;
|
||||
|
||||
/** Retrieve ACLs and Groups on a channel.
|
||||
* @param channelid Channel ID of channel to fetch from. See [Channel::id].
|
||||
* @param channelid Channel ID of channel to fetch from. See {@link Channel.id}.
|
||||
* @param acls List of ACLs on the channel. This will include inherited ACLs.
|
||||
* @param groups List of groups on the channel. This will include inherited groups.
|
||||
* @param inherit Does this channel inherit ACLs from the parent channel?
|
||||
@ -602,7 +602,7 @@ module Murmur
|
||||
idempotent void getACL(int channelid, out ACLList acls, out GroupList groups, out bool inherit) throws ServerBootedException, InvalidChannelException, InvalidSecretException;
|
||||
|
||||
/** Set ACLs and Groups on a channel. Note that this will replace all existing ACLs and groups on the channel.
|
||||
* @param channelid Channel ID of channel to fetch from. See [Channel::id].
|
||||
* @param channelid Channel ID of channel to fetch from. See {@link Channel.id}.
|
||||
* @param acls List of ACLs on the channel.
|
||||
* @param groups List of groups on the channel.
|
||||
* @param inherit Should this channel inherit ACLs from the parent channel?
|
||||
@ -610,28 +610,28 @@ module Murmur
|
||||
idempotent void setACL(int channelid, ACLList acls, GroupList groups, bool inherit) throws ServerBootedException, InvalidChannelException, InvalidSecretException;
|
||||
|
||||
/** Temporarily add a user to a group on a channel. This state is not saved, and is intended for temporary memberships.
|
||||
* @param channelid Channel ID of channel to add to. See [Channel::id].
|
||||
* @param session Connection ID of user. See [User::session].
|
||||
* @param channelid Channel ID of channel to add to. See {@link Channel.id}.
|
||||
* @param session Connection ID of user. See {@link User.session}.
|
||||
* @param group Group name to add to.
|
||||
*/
|
||||
idempotent void addUserToGroup(int channelid, int session, string group) throws ServerBootedException, InvalidChannelException, InvalidSessionException, InvalidSecretException;
|
||||
|
||||
/** Remove a user from a temporary group membership on a channel. This state is not saved, and is intended for temporary memberships.
|
||||
* @param channelid Channel ID of channel to add to. See [Channel::id].
|
||||
* @param session Connection ID of user. See [User::session].
|
||||
* @param channelid Channel ID of channel to add to. See {@link Channel.id}.
|
||||
* @param session Connection ID of user. See {@link User.session}.
|
||||
* @param group Group name to remove from.
|
||||
*/
|
||||
idempotent void removeUserFromGroup(int channelid, int session, string group) throws ServerBootedException, InvalidChannelException, InvalidSessionException, InvalidSecretException;
|
||||
|
||||
/** Redirect whisper targets for user. If set, whenever a user tries to whisper to group "source", the whisper will be redirected to group "target".
|
||||
* To remove a redirect pass an empty target string. This is intended for context groups.
|
||||
* @param session Connection ID of user. See [User::session].
|
||||
* @param session Connection ID of user. See {@link User.session}.
|
||||
* @param source Group name to redirect from.
|
||||
* @param target Group name to redirect to.
|
||||
*/
|
||||
idempotent void redirectWhisperGroup(int session, string source, string target) throws ServerBootedException, InvalidSessionException, InvalidSecretException;
|
||||
|
||||
/** Map a list of [User::userid] to a matching name.
|
||||
/** Map a list of {@link User.userid} to a matching name.
|
||||
* @param List of ids.
|
||||
* @return Matching list of names, with an empty string representing invalid or unknown ids.
|
||||
*/
|
||||
@ -645,12 +645,12 @@ module Murmur
|
||||
|
||||
/** Register a new user.
|
||||
* @param info Information about new user. Must include at least "name".
|
||||
* @return The ID of the user. See [RegisteredUser::userid].
|
||||
* @return The ID of the user. See {@link RegisteredUser.userid}.
|
||||
*/
|
||||
int registerUser(UserInfoMap info) throws ServerBootedException, InvalidUserException, InvalidSecretException;
|
||||
|
||||
/** Remove a user registration.
|
||||
* @param userid ID of registered user. See [RegisteredUser::userid].
|
||||
* @param userid ID of registered user. See {@link RegisteredUser.userid}.
|
||||
*/
|
||||
void unregisterUser(int userid) throws ServerBootedException, InvalidUserException, InvalidSecretException;
|
||||
|
||||
@ -661,7 +661,7 @@ module Murmur
|
||||
idempotent void updateRegistration(int userid, UserInfoMap info) throws ServerBootedException, InvalidUserException, InvalidSecretException;
|
||||
|
||||
/** Fetch registration for a single user.
|
||||
* @param userid ID of registered user. See [RegisteredUser::userid].
|
||||
* @param userid ID of registered user. See {@link RegisteredUser.userid}.
|
||||
* @return Registration record.
|
||||
*/
|
||||
idempotent UserInfoMap getRegistration(int userid) throws ServerBootedException, InvalidUserException, InvalidSecretException;
|
||||
@ -673,20 +673,20 @@ module Murmur
|
||||
idempotent NameMap getRegisteredUsers(string filter) throws ServerBootedException, InvalidSecretException;
|
||||
|
||||
/** Verify the password of a user. You can use this to verify a user's credentials.
|
||||
* @param name User name. See [RegisteredUser::name].
|
||||
* @param name User name. See {@link RegisteredUser.name}.
|
||||
* @param pw User password.
|
||||
* @return User ID of registered user (See [RegisteredUser::userid]), -1 for failed authentication or -2 for unknown usernames.
|
||||
* @return User ID of registered user (See {@link RegisteredUser.userid}), -1 for failed authentication or -2 for unknown usernames.
|
||||
*/
|
||||
idempotent int verifyPassword(string name, string pw) throws ServerBootedException, InvalidSecretException;
|
||||
|
||||
/** Fetch user texture. Textures are stored as zlib compress()ed 600x60 32-bit BGRA data.
|
||||
* @param userid ID of registered user. See [RegisteredUser::userid].
|
||||
* @param userid ID of registered user. See {@link RegisteredUser.userid}.
|
||||
* @return Custom texture associated with user or an empty texture.
|
||||
*/
|
||||
idempotent Texture getTexture(int userid) throws ServerBootedException, InvalidUserException, InvalidSecretException;
|
||||
|
||||
/** Set user texture. The texture is a 600x60 32-bit BGRA raw texture, optionally zlib compress()ed.
|
||||
* @param userid ID of registered user. See [RegisteredUser::userid].
|
||||
* @param userid ID of registered user. See {@link RegisteredUser.userid}.
|
||||
* @param tex Texture to set for the user, or an empty texture to remove the existing texture.
|
||||
*/
|
||||
idempotent void setTexture(int userid, Texture tex) throws ServerBootedException, InvalidUserException, InvalidTextureException, InvalidSecretException;
|
||||
@ -703,7 +703,7 @@ module Murmur
|
||||
* Please note that all callbacks are done asynchronously; murmur does not wait for the callback to
|
||||
* complete before continuing processing.
|
||||
* @see ServerCallback
|
||||
* @see Meta::addCallback
|
||||
* @see Meta.addCallback
|
||||
*/
|
||||
interface MetaCallback {
|
||||
/** Called when a server is started. The server is up and running when this event is sent, so all methods that
|
||||
@ -721,16 +721,16 @@ module Murmur
|
||||
|
||||
sequence<Server *> ServerList;
|
||||
|
||||
/** This is the meta interface. It is primarily used for retrieving the [Server] interfaces for each individual server.
|
||||
/** This is the meta interface. It is primarily used for retrieving the {@link Server} interfaces for each individual server.
|
||||
**/
|
||||
["amd"] interface Meta {
|
||||
/** Fetch interface to specific server.
|
||||
* @param id Server ID. See [Server::getId].
|
||||
* @param id Server ID. See {@link Server.getId}.
|
||||
* @return Interface for specified server, or a null proxy if id is invalid.
|
||||
*/
|
||||
idempotent Server *getServer(int id) throws InvalidSecretException;
|
||||
|
||||
/** Create a new server. Call [Server::getId] on the returned interface to find it's ID.
|
||||
/** Create a new server. Call {@link Server.getId} on the returned interface to find it's ID.
|
||||
* @return Interface for new server.
|
||||
*/
|
||||
Server *newServer() throws InvalidSecretException;
|
||||
@ -757,7 +757,7 @@ module Murmur
|
||||
* @param major Major version.
|
||||
* @param minor Minor version.
|
||||
* @param patch Patchlevel.
|
||||
* @param text Textual representation of version. Note that this may not match the [major], [minor] and [patch] levels, as it
|
||||
* @param text Textual representation of version. Note that this may not match the {@link major}, {@link minor} and {@link patch} levels, as it
|
||||
* may be simply the compile date or the SVN revision. This is usually the text you want to present to users.
|
||||
*/
|
||||
idempotent void getVersion(out int major, out int minor, out int patch, out string text);
|
||||
|
||||
Loading…
Reference in New Issue
Block a user