diff --git a/MumbleServer.ice b/MumbleServer.ice new file mode 100644 index 0000000..426f27c --- /dev/null +++ b/MumbleServer.ice @@ -0,0 +1,958 @@ +// Copyright The Mumble Developers. All rights reserved. +// Use of this source code is governed by a BSD-style license +// that can be found in the LICENSE file at the root of the +// Mumble source tree or at . + +/** + * + * Information and control of the Mumble server. Each server has + * one {@link Meta} interface that controls global information, and + * each virtual server has a {@link Server} interface. + * + **/ + + +module MumbleServer +{ + + /** A network address in IPv6 format. + **/ + ["python:seq:tuple"] sequence NetAddress; + + /** A connected user. + **/ + struct User { + /** Session ID. This identifies the connection to the server. */ + int session; + /** User ID. -1 if the user is anonymous. */ + int userid; + /** Is user muted by the server? */ + bool mute; + /** Is user deafened by the server? If true, this implies mute. */ + bool deaf; + /** Is the user suppressed by the server? This means the user is not muted, but does not have speech privileges in the current channel. */ + bool suppress; + /** Is the user a priority speaker? */ + bool prioritySpeaker; + /** Is the user self-muted? */ + bool selfMute; + /** Is the user self-deafened? If true, this implies mute. */ + bool selfDeaf; + /** Is the User recording? (This flag is read-only and cannot be changed using setState().) **/ + bool recording; + /** Channel ID the user is in. Matches {@link Channel.id}. */ + int channel; + /** The name of the user. */ + string name; + /** Seconds user has been online. */ + int onlinesecs; + /** Average transmission rate in bytes per second over the last few seconds. */ + int bytespersec; + /** Legacy client version. */ + int version; + /** New client version. (See https://github.com/mumble-voip/mumble/issues/5827) */ + long version2; + /** Client release. For official releases, this equals the version. For snapshots and git compiles, this will be something else. */ + string release; + /** Client OS. */ + string os; + /** Client OS Version. */ + string osversion; + /** Plugin Identity. This will be the user's unique ID inside the current game. */ + string identity; + /** + Base64-encoded Plugin context. This is a binary blob identifying the game and team the user is on. + + The used Base64 alphabet is the one specified in RFC 2045. + + Before Mumble 1.3.0, this string was not Base64-encoded. This could cause problems for some Ice + implementations, such as the .NET implementation. + + If you need the exact string that is used by Mumble, you can get it by Base64-decoding this string. + + If you simply need to detect whether two users are in the same game world, string comparisons will + continue to work as before. + */ + string context; + /** User comment. Shown as tooltip for this user. */ + string comment; + /** Client address. */ + NetAddress address; + /** TCP only. True until UDP connectivity is established. */ + bool tcponly; + /** Idle time. This is how many seconds it is since the user last spoke. Other activity is not counted. */ + int idlesecs; + /** UDP Ping Average. This is the average ping for the user via UDP over the duration of the connection. */ + float udpPing; + /** TCP Ping Average. This is the average ping for the user via TCP over the duration of the connection. */ + float tcpPing; + }; + + sequence IntList; + + /** A text message between users. + **/ + struct TextMessage { + /** Sessions (connected users) who were sent this message. */ + IntList sessions; + /** Channels who were sent this message. */ + IntList channels; + /** Trees of channels who were sent this message. */ + IntList trees; + /** The contents of the message. */ + string text; + }; + + /** A channel. + **/ + struct Channel { + /** Channel ID. This is unique per channel, and the root channel is always id 0. */ + int id; + /** Name of the channel. There can not be two channels with the same parent that has the same name. */ + string name; + /** ID of parent channel, or -1 if this is the root channel. */ + int parent; + /** List of id of linked channels. */ + IntList links; + /** Description of channel. Shown as tooltip for this channel. */ + string description; + /** Channel is temporary, and will be removed when the last user leaves it. Read-only. */ + bool temporary; + /** Position of the channel which is used in Client for sorting. */ + int position; + }; + + /** A group. Groups are defined per channel, and can inherit members from parent channels. + **/ + struct Group { + /** Group name */ + string name; + /** Is this group inherited from a parent channel? Read-only. */ + bool inherited; + /** Does this group inherit members from parent channels? */ + bool inherit; + /** Can subchannels inherit members from this group? */ + bool inheritable; + /** List of users to add to the group. */ + IntList add; + /** List of inherited users to remove from the group. */ + IntList remove; + /** Current members of the group, including inherited members. Read-only. */ + IntList members; + }; + + /** Write access to channel control. Implies all other permissions (except Speak). */ + const int PermissionWrite = 0x01; + /** Traverse channel. Without this, a client cannot reach subchannels, no matter which privileges he has there. */ + const int PermissionTraverse = 0x02; + /** Enter channel. */ + const int PermissionEnter = 0x04; + /** Speak in channel. */ + const int PermissionSpeak = 0x08; + /** Whisper to channel. This is different from Speak, so you can set up different permissions. */ + const int PermissionWhisper = 0x100; + /** Mute and deafen other users in this channel. */ + const int PermissionMuteDeafen = 0x10; + /** Move users from channel. You need this permission in both the source and destination channel to move another user. */ + const int PermissionMove = 0x20; + /** Make new channel as a subchannel of this channel. */ + const int PermissionMakeChannel = 0x40; + /** Make new temporary channel as a subchannel of this channel. */ + const int PermissionMakeTempChannel = 0x400; + /** Link this channel. You need this permission in both the source and destination channel to link channels, or in either channel to unlink them. */ + const int PermissionLinkChannel = 0x80; + /** Send text message to channel. */ + const int PermissionTextMessage = 0x200; + /** Kick user from server. Only valid on root channel. */ + const int PermissionKick = 0x10000; + /** Ban user from server. Only valid on root channel. */ + const int PermissionBan = 0x20000; + /** Register and unregister users. Only valid on root channel. */ + const int PermissionRegister = 0x40000; + /** Register and unregister users. Only valid on root channel. */ + const int PermissionRegisterSelf = 0x80000; + /** Reset the comment or avatar of a user. Only valid on root channel. */ + const int ResetUserContent = 0x100000; + + + /** Access Control List for a channel. ACLs are defined per channel, and can be inherited from parent channels. + **/ + struct ACL { + /** Does the ACL apply to this channel? */ + bool applyHere; + /** Does the ACL apply to subchannels? */ + bool applySubs; + /** Is this ACL inherited from a parent channel? Read-only. */ + bool inherited; + /** ID of user this ACL applies to. -1 if using a group name. */ + int userid; + /** Group this ACL applies to. Blank if using userid. */ + string group; + /** Binary mask of privileges to allow. */ + int allow; + /** Binary mask of privileges to deny. */ + int deny; + }; + + /** A single ip mask for a ban. + **/ + struct Ban { + /** Address to ban. */ + NetAddress address; + /** Number of bits in ban to apply. */ + int bits; + /** Username associated with ban. */ + string name; + /** Hash of banned user. */ + string hash; + /** Reason for ban. */ + string reason; + /** Date ban was applied in unix time format. */ + int start; + /** Duration of ban. */ + int duration; + }; + + /** A entry in the log. + **/ + struct LogEntry { + /** Timestamp in UNIX time_t */ + int timestamp; + /** The log message. */ + string txt; + }; + + class Tree; + sequence TreeList; + + enum ChannelInfo { ChannelDescription, ChannelPosition }; + enum UserInfo { UserName, UserEmail, UserComment, UserHash, UserPassword, UserLastActive, UserKDFIterations }; + + dictionary UserMap; + dictionary ChannelMap; + sequence ChannelList; + sequence UserList; + sequence GroupList; + sequence ACLList; + sequence LogList; + sequence BanList; + sequence IdList; + sequence NameList; + dictionary NameMap; + dictionary IdMap; + sequence Texture; + dictionary ConfigMap; + sequence GroupNameList; + sequence CertificateDer; + sequence CertificateList; + + /** User information map. + * Older versions of ice-php can't handle enums as keys. If you are using one of these, replace 'UserInfo' with 'byte'. + */ + + dictionary UserInfoMap; + + /** User and subchannel state. Read-only. + **/ + class Tree { + /** Channel definition of current channel. */ + Channel c; + /** List of subchannels. */ + TreeList children; + /** Users in this channel. */ + UserList users; + }; + + /** Different states of the underlying database */ + enum DBState { Normal, ReadOnly }; + + exception ServerException {}; + /** Thrown if the server encounters an internal error while processing the request */ + exception InternalErrorException extends ServerException {}; + /** 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 ServerException {}; + /** 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 ServerException {}; + /** This is thrown when you try to do an operation on a server that does not exist. This may happen if someone has removed the server. */ + exception InvalidServerException extends ServerException {}; + /** 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 ServerException {}; + /** This is thrown if {@link Server.start} fails, and should generally be the cause for some concern. */ + exception ServerFailureException extends ServerException {}; + /** This is thrown when you specify an invalid userid. */ + exception InvalidUserException extends ServerException {}; + /** This is thrown when you try to set an invalid texture. */ + exception InvalidTextureException extends ServerException {}; + /** This is thrown when you supply an invalid callback. */ + exception InvalidCallbackException extends ServerException {}; + /** This is thrown when you supply the wrong secret in the calling context. */ + exception InvalidSecretException extends ServerException {}; + /** This is thrown when the channel operation would exceed the channel nesting limit */ + exception NestingLimitException extends ServerException {}; + /** This is thrown when you ask the server to disclose something that should be secret. */ + exception WriteOnlyException extends ServerException {}; + /** This is thrown when invalid input data was specified. */ + exception InvalidInputDataException extends ServerException {}; + /** This is thrown when the referenced channel listener does not actually exist */ + exception InvalidListenerException extends ServerException {}; + /** This is thrown when the server has its database in read-only mode and whatever you requested is incompatible with that. */ + exception ReadOnlyModeException extends ServerException {}; + + /** Callback interface for servers. You can supply an implementation of this to receive notification + * messages from the server. + * If an added callback ever throws an exception or goes away, it will be automatically removed. + * Please note that all callbacks are done asynchronously; the server 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 + * {@link MetaCallback.started} which calls {@link Server.addCallback}. + * @see MetaCallback + * @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 {@link Server.getState} + * to retrieve the user's state. + * @param state State of disconnected user. + */ + idempotent void userDisconnected(User state); + /** Called when a user state changes. This is called if the user moves, is renamed, is muted, deafened etc. + * @param state New state of user. + */ + idempotent void userStateChanged(User state); + /** Called when user writes a text message + * @param state the User sending the message + * @param message the TextMessage the user has sent + */ + idempotent void userTextMessage(User state, TextMessage message); + /** Called when a new channel is created. + * @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 {@link Server.getChannelState} + * @param state State of removed channel. + */ + idempotent void channelRemoved(Channel state); + /** Called when a new channel state changes. This is called if the channel is moved, renamed or if new links are added. + * @param state New state of channel. + */ + idempotent void channelStateChanged(Channel state); + }; + + /** Context for actions in the Server menu. */ + const int ContextServer = 0x01; + /** Context for actions in the Channel menu. */ + const int ContextChannel = 0x02; + /** Context for actions in the User menu. */ + const int ContextUser = 0x04; + + /** 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; the server does not wait for the callback to + * complete before continuing processing. + */ + interface ServerContextCallback { + /** Called when a context action is performed. + * @param action Action to be performed. + * @param usr User which initiated the action. + * @param session If nonzero, session of target user. + * @param channelid If not -1, id of target channel. + */ + idempotent void contextAction(string action, User usr, int session, int channelid); + }; + + /** 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 {@link ServerCallback} and {@link ServerContextCallback}, these methods are called + * synchronously. If the response lags, the entire server will lag. + * Also note that, as the method calls are synchronous, making a call to {@link Server} or {@link Meta} will + * deadlock the server. + */ + interface ServerAuthenticator { + /** Called to authenticate a user. If you do not know the username in question, always return -2 from this + * method to fall through to normal database authentication. + * Note that if authentication succeeds, the server will create a record of the user in it's database, reserving + * the username and id so it cannot be used for normal database authentication. + * The data in the certificate (name, email addresses etc), as well as the list of signing certificates, + * should only be trusted if certstrong is true. + * + * Internally, the server treats usernames as case-insensitive. It is recommended + * that authenticators do the same. the server checks if a username is in use when + * a user connects. If the connecting user is registered, the other username is + * kicked. If the connecting user is not registered, the connecting user is not + * allowed to join the server. + * + * @param name Username to authenticate. + * @param pw Password to authenticate with. + * @param certificates List of der encoded certificates the user connected with. + * @param certhash Hash of user certificate, as used by the server internally when matching. + * @param certstrong True if certificate was valid and signed by a trusted CA. + * @param newname Set this to change the username from the supplied one. + * @param groups List of groups on the root channel that the user will be added to for the duration of the connection. + * @return UserID of authenticated user, -1 for authentication failures, -2 for unknown user (fallthrough), + * -3 for authentication failures where the data could (temporarily) not be verified. + */ + idempotent int authenticate(string name, string pw, CertificateList certificates, string certhash, bool certstrong, out string newname, out GroupNameList groups); + + /** Fetch information about a user. This is used to retrieve information like email address, keyhash etc. If you + * want the server to take care of this information itself, simply return false to fall through. + * @param id User id. + * @param info Information about user. This needs to include at least "name". + * @return true if information is present, false to fall through. + */ + idempotent bool getInfo(int id, out UserInfoMap info); + + /** Map a name to a user id. + * @param name Username to map. + * @return User id or -2 for unknown name. + */ + idempotent int nameToId(string name); + + /** Map a user id to a username. + * @param id User id to map. + * @return Name of user or empty string for unknown id. + */ + idempotent string idToName(int id); + + /** Map a user to a custom Texture. + * @param id User id to map. + * @return User texture or an empty texture for unknown users or users without textures. + */ + idempotent Texture idToTexture(int id); + }; + + /** 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. {@link Server.setTexture}. + * Almost all of these methods support fall through, meaning the server should continue the operation against its + * own database. + */ + interface ServerUpdatingAuthenticator extends ServerAuthenticator { + /** Register a new user. + * @param info Information about user to register. + * @return User id of new user, -1 for registration failure, or -2 to fall through. + */ + int registerUser(UserInfoMap info); + + /** Unregister a user. + * @param id Userid to unregister. + * @return 1 for successful unregistration, 0 for unsuccessful unregistration, -1 to fall through. + */ + int unregisterUser(int id); + + /** Get a list of registered users matching filter. + * @param filter Substring usernames must contain. If empty, return all registered users. + * @return List of matching registered users. + */ + idempotent NameMap getRegisteredUsers(string filter); + + /** Set additional information for user registration. + * @param id Userid of registered user. + * @param info Information to set about user. This should be merged with existing information. + * @return 1 for successful update, 0 for unsuccessful update, -1 to fall through. + */ + idempotent int setInfo(int id, UserInfoMap info); + + /** Set texture (now called avatar) of user registration. + * @param id registrationId of registered user. + * @param tex New texture. + * @return 1 for successful update, 0 for unsuccessful update, -1 to fall through. + */ + idempotent int setTexture(int id, Texture tex); + }; + + /** 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 {@link Meta}. + **/ + ["amd"] interface Server { + /** Shows if the server currently running (accepting users). + * + * @return Run-state of server. + */ + idempotent bool isRunning() throws InvalidSecretException; + + /** Start server. */ + void start() throws ServerBootedException, ServerFailureException, InvalidSecretException, ReadOnlyModeException; + + /** Stop server. + * Note: Server will be restarted on application restart unless explicitly disabled + * with setConf("boot", false) + */ + void stop() throws ServerBootedException, InvalidSecretException, ReadOnlyModeException; + + /** Delete server and all it's configuration. */ + void delete() throws ServerBootedException, InvalidSecretException, ReadOnlyModeException; + + /** Fetch the server id. + * + * @return Unique server id. + */ + idempotent int id() throws InvalidSecretException; + + /** Add a callback. The callback will receive notifications about changes to users and channels. + * + * @param cb Callback interface which will receive notifications. + * @see removeCallback + */ + void addCallback(ServerCallback *cb) throws ServerBootedException, InvalidCallbackException, InvalidSecretException; + + /** Remove a callback. + * + * @param cb Callback interface to be removed. + * @see addCallback + */ + void removeCallback(ServerCallback *cb) throws ServerBootedException, InvalidCallbackException, InvalidSecretException; + + /** Set external authenticator. If set, all authentications from clients are forwarded to this + * proxy. + * + * @param auth Authenticator object to perform subsequent authentications. + */ + void setAuthenticator(ServerAuthenticator *auth) throws ServerBootedException, InvalidCallbackException, InvalidSecretException, ReadOnlyModeException; + + /** Retrieve configuration item. + * @param key Configuration key. + * @return Configuration value. If this is empty, see {@link Meta.getDefaultConf} + */ + idempotent string getConf(string key) throws InvalidSecretException, WriteOnlyException, ReadOnlyModeException; + + /** Retrieve all configuration items. + * @return All configured values. If a value isn't set here, the value from {@link Meta.getDefaultConf} is used. + */ + idempotent ConfigMap getAllConf() throws InvalidSecretException, ReadOnlyModeException; + + /** Set a configuration item. + * @param key Configuration key. + * @param value Configuration value. + */ + idempotent void setConf(string key, string value) throws InvalidSecretException, ReadOnlyModeException; + + /** 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, ReadOnlyModeException; + + /** Fetch log entries. + * @param first Lowest numbered entry to fetch. 0 is the most recent item. + * @param last Last entry to fetch. + * @return List of log entries. + */ + idempotent LogList getLog(int first, int last) throws InvalidSecretException, ReadOnlyModeException; + + /** Fetch length of log + * @return Number of entries in log + */ + idempotent int getLogLen() throws InvalidSecretException, ReadOnlyModeException; + + /** Fetch all users. This returns all currently connected users on the server. + * @return List of connected users. + * @see getState + */ + idempotent UserMap getUsers() throws ServerBootedException, InvalidSecretException; + + /** Fetch all channels. This returns all defined channels on the server. The root channel is always channel 0. + * @return List of defined channels. + * @see getChannelState + */ + 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 {@link User.session}. + * @return Certificate list of user. + */ + idempotent CertificateList getCertificateList(int session) throws ServerBootedException, InvalidSessionException, InvalidSecretException; + + /** Fetch all channels and connected users as a tree. This retrieves an easy-to-use representation of the server + * as a tree. This is primarily used for viewing the state of the server on a webpage. + * @return Recursive tree of all channels and connected users. + */ + idempotent Tree getTree() throws ServerBootedException, InvalidSecretException; + + /** Fetch all current IP bans on the server. + * @return List of bans. + */ + 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 {@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, ReadOnlyModeException; + + /** Kick a user. The user is not banned, and is free to rejoin the server. + * @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 {@link User.session}. + * @return State of connected user. + * @see setState + * @see getUsers + */ + idempotent User getState(int session) throws ServerBootedException, InvalidSessionException, InvalidSecretException; + + /** Set user state. You can use this to move, mute and deafen users. + * @param state User state to set. + * @see getState + */ + idempotent void setState(User state) throws ServerBootedException, InvalidSessionException, InvalidChannelException, InvalidSecretException; + + /** Send text message to a single user. + * @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 {@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. + */ + bool hasPermission(int session, int channelid, int perm) throws ServerBootedException, InvalidSessionException, InvalidChannelException, InvalidSecretException; + + /** Return users effective permissions + * @param session Connection ID of user. See {@link User.session}. + * @param channelid ID of Channel. See {@link Channel.id}. + * @return bitfield of allowed actions + */ + idempotent int effectivePermissions(int session, int channelid) throws ServerBootedException, InvalidSessionException, InvalidChannelException, InvalidSecretException; + + /** Add a context callback. This is done per user, and will add a context menu action for the user. + * + * @param session Session of user which should receive context entry. + * @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 {@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; + + /** Remove a callback. + * + * @param cb Callback interface to be removed. This callback will be removed from all from all users. + * @see addContextCallback + */ + void removeContextCallback(ServerContextCallback *cb) throws ServerBootedException, InvalidCallbackException, InvalidSecretException; + + /** Get state of single channel. + * @param channelid ID of Channel. See {@link Channel.id}. + * @return State of channel. + * @see setChannelState + * @see getChannels + */ + idempotent Channel getChannelState(int channelid) throws ServerBootedException, InvalidChannelException, InvalidSecretException; + + /** Set state of a single channel. You can use this to move or relink channels. + * @param state Channel state to set. + * @see getChannelState + */ + idempotent void setChannelState(Channel state) throws ServerBootedException, InvalidChannelException, InvalidSecretException, NestingLimitException, ReadOnlyModeException; + + /** Remove a channel and all its subchannels. + * @param channelid ID of Channel. See {@link Channel.id}. + */ + void removeChannel(int channelid) throws ServerBootedException, InvalidChannelException, InvalidSecretException, ReadOnlyModeException; + + /** Add a new channel. + * @param name Name of new channel. + * @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, NestingLimitException, ReadOnlyModeException; + + /** Send text message to channel or a tree of channels. + * @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 + */ + 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 {@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? + */ + 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 {@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? + */ + idempotent void setACL(int channelid, ACLList acls, GroupList groups, bool inherit) throws ServerBootedException, InvalidChannelException, InvalidSecretException, ReadOnlyModeException; + + /** 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 {@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 {@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 {@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 {@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. + */ + idempotent NameMap getUserNames(IdList ids) throws ServerBootedException, InvalidSecretException; + + /** Map a list of user names to a matching id. + * @param List of names. + * @reuturn List of matching ids, with -1 representing invalid or unknown user names. + */ + idempotent IdMap getUserIds(NameList names) throws ServerBootedException, InvalidSecretException; + + /** Register a new user. + * @param info Information about new user. Must include at least "name". + * @return The ID of the user. See {@link RegisteredUser.userid}. + */ + int registerUser(UserInfoMap info) throws ServerBootedException, InvalidUserException, InvalidSecretException, ReadOnlyModeException; + + /** Remove a user registration. + * @param userid ID of registered user. See {@link RegisteredUser.userid}. + */ + void unregisterUser(int userid) throws ServerBootedException, InvalidUserException, InvalidSecretException, ReadOnlyModeException; + + /** Update the registration for a user. You can use this to set the email or password of a user, + * and can also use it to change the user's name. + * @param registration Updated registration record. + */ + idempotent void updateRegistration(int userid, UserInfoMap info) throws ServerBootedException, InvalidUserException, InvalidSecretException, ReadOnlyModeException; + + /** Fetch registration for a single user. + * @param userid ID of registered user. See {@link RegisteredUser.userid}. + * @return Registration record. + */ + idempotent UserInfoMap getRegistration(int userid) throws ServerBootedException, InvalidUserException, InvalidSecretException, ReadOnlyModeException; + + /** Fetch a group of registered users. + * @param filter Substring of user name. If blank, will retrieve all registered users. + * @return List of registration records. + */ + idempotent NameMap getRegisteredUsers(string filter) throws ServerBootedException, InvalidSecretException, ReadOnlyModeException; + + /** Verify the password of a user. You can use this to verify a user's credentials. + * @param name User name. See {@link RegisteredUser.name}. + * @param pw User password. + * @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, ReadOnlyModeException; + + /** Fetch user texture. Textures are stored as zlib compress()ed 600x60 32-bit BGRA data. + * @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 a user texture (now called avatar). + * @param userid ID of registered user. See {@link RegisteredUser.userid}. + * @param tex Texture (as a Byte-Array) 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, ReadOnlyModeException; + + /** Get virtual server uptime. + * @return Uptime of the virtual server in seconds + */ + idempotent int getUptime() throws ServerBootedException, InvalidSecretException; + + /** + * Update the server's certificate information. + * + * Reconfigure the running server's TLS socket with the given + * certificate and private key. + * + * The certificate and and private key must be PEM formatted. + * + * New clients will see the new certificate. + * Existing clients will continue to see the certificate the server + * was using when they connected to it. + * + * This method throws InvalidInputDataException if any of the + * following errors happen: + * - Unable to decode the PEM certificate and/or private key. + * - Unable to decrypt the private key with the given passphrase. + * - The certificate and/or private key do not contain RSA keys. + * - The certificate is not usable with the given private key. + */ + idempotent void updateCertificate(string certificate, string privateKey, string passphrase) throws ServerBootedException, InvalidSecretException, InvalidInputDataException, ReadOnlyModeException; + + /** + * Makes the given user start listening to the given channel. + * @param userid The ID of the user + * @param channelid The ID of the channel + */ + idempotent void startListening(int userid, int channelid) throws ServerBootedException, InvalidUserException, ReadOnlyModeException; + + /** + * Makes the given user stop listening to the given channel. + * @param userid The ID of the user + * @param channelid The ID of the channel + */ + idempotent void stopListening(int userid, int channelid) throws ServerBootedException, InvalidUserException, ReadOnlyModeException; + + /** + * @param userid The ID of the user + * @param channelid The ID of the channel + * @returns Whether the given user is currently listening to the given channel + */ + idempotent bool isListening(int userid, int channelid) throws ServerBootedException, InvalidUserException, InvalidSecretException; + + /** + * @param userid The ID of the user + * @returns An ID-list of channels the given user is listening to + */ + idempotent IntList getListeningChannels(int userid) throws ServerBootedException, InvalidSecretException, InvalidUserException; + + /** + * @param channelid The ID of the channel + * @returns An ID-list of users listening to the given channel + */ + idempotent IntList getListeningUsers(int channelid) throws ServerBootedException, InvalidSecretException, InvalidChannelException; + + /** + * @param channelid The ID of the channel + * @param userid The ID of the user + * @returns The volume adjustment set for a listener of the given user in the given channel + */ + idempotent float getListenerVolumeAdjustment(int channelid, int userid) throws ServerBootedException, InvalidUserException, InvalidChannelException; + + /** + * Sets the volume adjustment set for a listener of the given user in the given channel + * @param channelid The ID of the channel + * @param userid The ID of the user + */ + idempotent void setListenerVolumeAdjustment(int channelid, int userid, float volumeAdjustment) throws ServerBootedException, InvalidSecretException, InvalidChannelException, InvalidUserException, ReadOnlyModeException; + + /** + * @param receiverUserIDs list of IDs of the users the message shall be sent to + */ + idempotent void sendWelcomeMessage(IdList receiverUserIDs) throws ServerBootedException, InvalidSecretException, InvalidUserException; + }; + + /** Callback interface for Meta. You can supply an implementation of this to receive notifications + * when servers are stopped or started. + * If an added callback ever throws an exception or goes away, it will be automatically removed. + * Please note that all callbacks are done asynchronously; the server does not wait for the callback to + * complete before continuing processing. + * @see ServerCallback + * @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 + * need a running server will work. + * @param srv Interface for started server. + */ + void started(Server *srv); + + /** Called when a server is stopped. The server is already stopped when this event is sent, so no methods that + * need a running server will work. + * @param srv Interface for started server. + */ + void stopped(Server *srv); + }; + + sequence ServerList; + + /** 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 {@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 {@link Server.getId} on the returned interface to find it's ID. + * @return Interface for new server. + */ + Server *newServer() throws InvalidSecretException; + + /** Fetch list of all currently running servers. + * @return List of interfaces for running servers. + */ + idempotent ServerList getBootedServers() throws InvalidSecretException; + + /** Fetch list of all defined servers. + * @return List of interfaces for all servers. + */ + idempotent ServerList getAllServers() throws InvalidSecretException; + + /** Fetch default configuration. This returns the configuration items that were set in the configuration file, or + * the built-in default. The individual servers will use these values unless they have been overridden in the + * server specific configuration. The only special case is the port, which defaults to the value defined here + + * the servers ID - 1 (so that virtual server #1 uses the defined port, server #2 uses port+1 etc). + * @return Default configuration of the servers. + */ + idempotent ConfigMap getDefaultConf() throws InvalidSecretException; + + /** Fetch version of the server. + * @param major Major version. + * @param minor Minor version. + * @param patch Patchlevel. + * @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); + + /** Add a callback. The callback will receive notifications when servers are started or stopped. + * + * @param cb Callback interface which will receive notifications. + */ + void addCallback(MetaCallback *cb) throws InvalidCallbackException, InvalidSecretException; + + /** Remove a callback. + * + * @param cb Callback interface to be removed. + */ + void removeCallback(MetaCallback *cb) throws InvalidCallbackException, InvalidSecretException; + + /** Get the server's uptime. + * @return Uptime of the server in seconds + */ + idempotent int getUptime(); + + /** Get slice file. + * @return Contents of the slice file server compiled with. + */ + idempotent string getSlice(); + + /** Returns a checksum dict for the slice file. + * @return Checksum dict + */ + + /** + * @returns The state the underlying database is currently assumed to be in + */ + idempotent DBState getAssumedDatabaseState() throws InvalidSecretException; + + /** + * Sets the assumed state of the underlying database + */ + idempotent void setAssumedDatabaseState(DBState state) throws InvalidSecretException, ReadOnlyModeException; + }; +}; diff --git a/MumbleServer/ACL.py b/MumbleServer/ACL.py new file mode 100644 index 0000000..d7ccdc1 --- /dev/null +++ b/MumbleServer/ACL.py @@ -0,0 +1,59 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from dataclasses import dataclass + + +@dataclass(order=True, unsafe_hash=True) +class ACL: + """ + Access Control List for a channel. ACLs are defined per channel, and can be inherited from parent channels. + + Attributes + ---------- + applyHere : bool + Does the ACL apply to this channel? + applySubs : bool + Does the ACL apply to subchannels? + inherited : bool + Is this ACL inherited from a parent channel? Read-only. + userid : int + ID of user this ACL applies to. -1 if using a group name. + group : str + Group this ACL applies to. Blank if using userid. + allow : int + Binary mask of privileges to allow. + deny : int + Binary mask of privileges to deny. + + Notes + ----- + The Slice compiler generated this dataclass from Slice struct ``::MumbleServer::ACL``. + """ + applyHere: bool = False + applySubs: bool = False + inherited: bool = False + userid: int = 0 + group: str = "" + allow: int = 0 + deny: int = 0 + +_MumbleServer_ACL_t = IcePy.defineStruct( + "::MumbleServer::ACL", + ACL, + (), + ( + ("applyHere", (), IcePy._t_bool), + ("applySubs", (), IcePy._t_bool), + ("inherited", (), IcePy._t_bool), + ("userid", (), IcePy._t_int), + ("group", (), IcePy._t_string), + ("allow", (), IcePy._t_int), + ("deny", (), IcePy._t_int) + )) + +__all__ = ["ACL", "_MumbleServer_ACL_t"] diff --git a/MumbleServer/ACLList.py b/MumbleServer/ACLList.py new file mode 100644 index 0000000..655cf58 --- /dev/null +++ b/MumbleServer/ACLList.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ACL import _MumbleServer_ACL_t + +_MumbleServer_ACLList_t = IcePy.defineSequence("::MumbleServer::ACLList", (), _MumbleServer_ACL_t) + +__all__ = ["_MumbleServer_ACLList_t"] diff --git a/MumbleServer/Ban.py b/MumbleServer/Ban.py new file mode 100644 index 0000000..3da0c21 --- /dev/null +++ b/MumbleServer/Ban.py @@ -0,0 +1,67 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.NetAddress import _MumbleServer_NetAddress_t + +from dataclasses import dataclass +from dataclasses import field + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from collections.abc import Buffer + + +@dataclass +class Ban: + """ + A single ip mask for a ban. + + Attributes + ---------- + address : bytes + Address to ban. + bits : int + Number of bits in ban to apply. + name : str + Username associated with ban. + hash : str + Hash of banned user. + reason : str + Reason for ban. + start : int + Date ban was applied in unix time format. + duration : int + Duration of ban. + + Notes + ----- + The Slice compiler generated this dataclass from Slice struct ``::MumbleServer::Ban``. + """ + address: bytes = field(default_factory=bytes) + bits: int = 0 + name: str = "" + hash: str = "" + reason: str = "" + start: int = 0 + duration: int = 0 + +_MumbleServer_Ban_t = IcePy.defineStruct( + "::MumbleServer::Ban", + Ban, + (), + ( + ("address", (), _MumbleServer_NetAddress_t), + ("bits", (), IcePy._t_int), + ("name", (), IcePy._t_string), + ("hash", (), IcePy._t_string), + ("reason", (), IcePy._t_string), + ("start", (), IcePy._t_int), + ("duration", (), IcePy._t_int) + )) + +__all__ = ["Ban", "_MumbleServer_Ban_t"] diff --git a/MumbleServer/BanList.py b/MumbleServer/BanList.py new file mode 100644 index 0000000..2a2b04e --- /dev/null +++ b/MumbleServer/BanList.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.Ban import _MumbleServer_Ban_t + +_MumbleServer_BanList_t = IcePy.defineSequence("::MumbleServer::BanList", (), _MumbleServer_Ban_t) + +__all__ = ["_MumbleServer_BanList_t"] diff --git a/MumbleServer/CertificateDer.py b/MumbleServer/CertificateDer.py new file mode 100644 index 0000000..7f01576 --- /dev/null +++ b/MumbleServer/CertificateDer.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_CertificateDer_t = IcePy.defineSequence("::MumbleServer::CertificateDer", (), IcePy._t_byte) + +__all__ = ["_MumbleServer_CertificateDer_t"] diff --git a/MumbleServer/CertificateList.py b/MumbleServer/CertificateList.py new file mode 100644 index 0000000..34a0c89 --- /dev/null +++ b/MumbleServer/CertificateList.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.CertificateDer import _MumbleServer_CertificateDer_t + +_MumbleServer_CertificateList_t = IcePy.defineSequence("::MumbleServer::CertificateList", (), _MumbleServer_CertificateDer_t) + +__all__ = ["_MumbleServer_CertificateList_t"] diff --git a/MumbleServer/Channel.py b/MumbleServer/Channel.py new file mode 100644 index 0000000..f6ab708 --- /dev/null +++ b/MumbleServer/Channel.py @@ -0,0 +1,67 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.IntList import _MumbleServer_IntList_t + +from dataclasses import dataclass +from dataclasses import field + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from collections.abc import Buffer + + +@dataclass +class Channel: + """ + A channel. + + Attributes + ---------- + id : int + Channel ID. This is unique per channel, and the root channel is always id 0. + name : str + Name of the channel. There can not be two channels with the same parent that has the same name. + parent : int + ID of parent channel, or -1 if this is the root channel. + links : list[int] + List of id of linked channels. + description : str + Description of channel. Shown as tooltip for this channel. + temporary : bool + Channel is temporary, and will be removed when the last user leaves it. Read-only. + position : int + Position of the channel which is used in Client for sorting. + + Notes + ----- + The Slice compiler generated this dataclass from Slice struct ``::MumbleServer::Channel``. + """ + id: int = 0 + name: str = "" + parent: int = 0 + links: list[int] = field(default_factory=list) + description: str = "" + temporary: bool = False + position: int = 0 + +_MumbleServer_Channel_t = IcePy.defineStruct( + "::MumbleServer::Channel", + Channel, + (), + ( + ("id", (), IcePy._t_int), + ("name", (), IcePy._t_string), + ("parent", (), IcePy._t_int), + ("links", (), _MumbleServer_IntList_t), + ("description", (), IcePy._t_string), + ("temporary", (), IcePy._t_bool), + ("position", (), IcePy._t_int) + )) + +__all__ = ["Channel", "_MumbleServer_Channel_t"] diff --git a/MumbleServer/ChannelInfo.py b/MumbleServer/ChannelInfo.py new file mode 100644 index 0000000..6caf642 --- /dev/null +++ b/MumbleServer/ChannelInfo.py @@ -0,0 +1,31 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from enum import Enum + +class ChannelInfo(Enum): + """ + Notes + ----- + The Slice compiler generated this enum class from Slice enumeration ``::MumbleServer::ChannelInfo``. + """ + + ChannelDescription = 0 + + ChannelPosition = 1 + +_MumbleServer_ChannelInfo_t = IcePy.defineEnum( + "::MumbleServer::ChannelInfo", + ChannelInfo, + (), + { + 0: ChannelInfo.ChannelDescription, + 1: ChannelInfo.ChannelPosition, + } +) + +__all__ = ["ChannelInfo", "_MumbleServer_ChannelInfo_t"] diff --git a/MumbleServer/ChannelList.py b/MumbleServer/ChannelList.py new file mode 100644 index 0000000..b8dc1f2 --- /dev/null +++ b/MumbleServer/ChannelList.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.Channel import _MumbleServer_Channel_t + +_MumbleServer_ChannelList_t = IcePy.defineSequence("::MumbleServer::ChannelList", (), _MumbleServer_Channel_t) + +__all__ = ["_MumbleServer_ChannelList_t"] diff --git a/MumbleServer/ChannelMap.py b/MumbleServer/ChannelMap.py new file mode 100644 index 0000000..ebf400e --- /dev/null +++ b/MumbleServer/ChannelMap.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.Channel import _MumbleServer_Channel_t + +_MumbleServer_ChannelMap_t = IcePy.defineDictionary("::MumbleServer::ChannelMap", (), IcePy._t_int, _MumbleServer_Channel_t) + +__all__ = ["_MumbleServer_ChannelMap_t"] diff --git a/MumbleServer/ConfigMap.py b/MumbleServer/ConfigMap.py new file mode 100644 index 0000000..f09ce3e --- /dev/null +++ b/MumbleServer/ConfigMap.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_ConfigMap_t = IcePy.defineDictionary("::MumbleServer::ConfigMap", (), IcePy._t_string, IcePy._t_string) + +__all__ = ["_MumbleServer_ConfigMap_t"] diff --git a/MumbleServer/ContextChannel.py b/MumbleServer/ContextChannel.py new file mode 100644 index 0000000..20c7615 --- /dev/null +++ b/MumbleServer/ContextChannel.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +ContextChannel = 2 +""" +Context for actions in the Channel menu. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::ContextChannel``. +""" + +__all__ = ["ContextChannel"] diff --git a/MumbleServer/ContextServer.py b/MumbleServer/ContextServer.py new file mode 100644 index 0000000..62791a7 --- /dev/null +++ b/MumbleServer/ContextServer.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +ContextServer = 1 +""" +Context for actions in the Server menu. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::ContextServer``. +""" + +__all__ = ["ContextServer"] diff --git a/MumbleServer/ContextUser.py b/MumbleServer/ContextUser.py new file mode 100644 index 0000000..1f3630c --- /dev/null +++ b/MumbleServer/ContextUser.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +ContextUser = 4 +""" +Context for actions in the User menu. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::ContextUser``. +""" + +__all__ = ["ContextUser"] diff --git a/MumbleServer/DBState.py b/MumbleServer/DBState.py new file mode 100644 index 0000000..6c4cf1a --- /dev/null +++ b/MumbleServer/DBState.py @@ -0,0 +1,33 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from enum import Enum + +class DBState(Enum): + """ + Different states of the underlying database + + Notes + ----- + The Slice compiler generated this enum class from Slice enumeration ``::MumbleServer::DBState``. + """ + + Normal = 0 + + ReadOnly = 1 + +_MumbleServer_DBState_t = IcePy.defineEnum( + "::MumbleServer::DBState", + DBState, + (), + { + 0: DBState.Normal, + 1: DBState.ReadOnly, + } +) + +__all__ = ["DBState", "_MumbleServer_DBState_t"] diff --git a/MumbleServer/Group.py b/MumbleServer/Group.py new file mode 100644 index 0000000..1588015 --- /dev/null +++ b/MumbleServer/Group.py @@ -0,0 +1,67 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.IntList import _MumbleServer_IntList_t + +from dataclasses import dataclass +from dataclasses import field + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from collections.abc import Buffer + + +@dataclass +class Group: + """ + A group. Groups are defined per channel, and can inherit members from parent channels. + + Attributes + ---------- + name : str + Group name + inherited : bool + Is this group inherited from a parent channel? Read-only. + inherit : bool + Does this group inherit members from parent channels? + inheritable : bool + Can subchannels inherit members from this group? + add : list[int] + List of users to add to the group. + remove : list[int] + List of inherited users to remove from the group. + members : list[int] + Current members of the group, including inherited members. Read-only. + + Notes + ----- + The Slice compiler generated this dataclass from Slice struct ``::MumbleServer::Group``. + """ + name: str = "" + inherited: bool = False + inherit: bool = False + inheritable: bool = False + add: list[int] = field(default_factory=list) + remove: list[int] = field(default_factory=list) + members: list[int] = field(default_factory=list) + +_MumbleServer_Group_t = IcePy.defineStruct( + "::MumbleServer::Group", + Group, + (), + ( + ("name", (), IcePy._t_string), + ("inherited", (), IcePy._t_bool), + ("inherit", (), IcePy._t_bool), + ("inheritable", (), IcePy._t_bool), + ("add", (), _MumbleServer_IntList_t), + ("remove", (), _MumbleServer_IntList_t), + ("members", (), _MumbleServer_IntList_t) + )) + +__all__ = ["Group", "_MumbleServer_Group_t"] diff --git a/MumbleServer/GroupList.py b/MumbleServer/GroupList.py new file mode 100644 index 0000000..be988cf --- /dev/null +++ b/MumbleServer/GroupList.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.Group import _MumbleServer_Group_t + +_MumbleServer_GroupList_t = IcePy.defineSequence("::MumbleServer::GroupList", (), _MumbleServer_Group_t) + +__all__ = ["_MumbleServer_GroupList_t"] diff --git a/MumbleServer/GroupNameList.py b/MumbleServer/GroupNameList.py new file mode 100644 index 0000000..4f09a22 --- /dev/null +++ b/MumbleServer/GroupNameList.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_GroupNameList_t = IcePy.defineSequence("::MumbleServer::GroupNameList", (), IcePy._t_string) + +__all__ = ["_MumbleServer_GroupNameList_t"] diff --git a/MumbleServer/IdList.py b/MumbleServer/IdList.py new file mode 100644 index 0000000..8a984cd --- /dev/null +++ b/MumbleServer/IdList.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_IdList_t = IcePy.defineSequence("::MumbleServer::IdList", (), IcePy._t_int) + +__all__ = ["_MumbleServer_IdList_t"] diff --git a/MumbleServer/IdMap.py b/MumbleServer/IdMap.py new file mode 100644 index 0000000..08fb757 --- /dev/null +++ b/MumbleServer/IdMap.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_IdMap_t = IcePy.defineDictionary("::MumbleServer::IdMap", (), IcePy._t_string, IcePy._t_int) + +__all__ = ["_MumbleServer_IdMap_t"] diff --git a/MumbleServer/IntList.py b/MumbleServer/IntList.py new file mode 100644 index 0000000..1b258a7 --- /dev/null +++ b/MumbleServer/IntList.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_IntList_t = IcePy.defineSequence("::MumbleServer::IntList", (), IcePy._t_int) + +__all__ = ["_MumbleServer_IntList_t"] diff --git a/MumbleServer/InternalErrorException.py b/MumbleServer/InternalErrorException.py new file mode 100644 index 0000000..cf17bd0 --- /dev/null +++ b/MumbleServer/InternalErrorException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class InternalErrorException(ServerException): + """ + Thrown if the server encounters an internal error while processing the request + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::InternalErrorException``. + """ + + _ice_id = "::MumbleServer::InternalErrorException" + +_MumbleServer_InternalErrorException_t = IcePy.defineException( + "::MumbleServer::InternalErrorException", + InternalErrorException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(InternalErrorException, '_ice_type', _MumbleServer_InternalErrorException_t) + +__all__ = ["InternalErrorException", "_MumbleServer_InternalErrorException_t"] diff --git a/MumbleServer/InvalidCallbackException.py b/MumbleServer/InvalidCallbackException.py new file mode 100644 index 0000000..5091939 --- /dev/null +++ b/MumbleServer/InvalidCallbackException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class InvalidCallbackException(ServerException): + """ + This is thrown when you supply an invalid callback. + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::InvalidCallbackException``. + """ + + _ice_id = "::MumbleServer::InvalidCallbackException" + +_MumbleServer_InvalidCallbackException_t = IcePy.defineException( + "::MumbleServer::InvalidCallbackException", + InvalidCallbackException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(InvalidCallbackException, '_ice_type', _MumbleServer_InvalidCallbackException_t) + +__all__ = ["InvalidCallbackException", "_MumbleServer_InvalidCallbackException_t"] diff --git a/MumbleServer/InvalidChannelException.py b/MumbleServer/InvalidChannelException.py new file mode 100644 index 0000000..dca56b7 --- /dev/null +++ b/MumbleServer/InvalidChannelException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class InvalidChannelException(ServerException): + """ + 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. + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::InvalidChannelException``. + """ + + _ice_id = "::MumbleServer::InvalidChannelException" + +_MumbleServer_InvalidChannelException_t = IcePy.defineException( + "::MumbleServer::InvalidChannelException", + InvalidChannelException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(InvalidChannelException, '_ice_type', _MumbleServer_InvalidChannelException_t) + +__all__ = ["InvalidChannelException", "_MumbleServer_InvalidChannelException_t"] diff --git a/MumbleServer/InvalidInputDataException.py b/MumbleServer/InvalidInputDataException.py new file mode 100644 index 0000000..cad49c8 --- /dev/null +++ b/MumbleServer/InvalidInputDataException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class InvalidInputDataException(ServerException): + """ + This is thrown when invalid input data was specified. + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::InvalidInputDataException``. + """ + + _ice_id = "::MumbleServer::InvalidInputDataException" + +_MumbleServer_InvalidInputDataException_t = IcePy.defineException( + "::MumbleServer::InvalidInputDataException", + InvalidInputDataException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(InvalidInputDataException, '_ice_type', _MumbleServer_InvalidInputDataException_t) + +__all__ = ["InvalidInputDataException", "_MumbleServer_InvalidInputDataException_t"] diff --git a/MumbleServer/InvalidListenerException.py b/MumbleServer/InvalidListenerException.py new file mode 100644 index 0000000..ca38372 --- /dev/null +++ b/MumbleServer/InvalidListenerException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class InvalidListenerException(ServerException): + """ + This is thrown when the referenced channel listener does not actually exist + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::InvalidListenerException``. + """ + + _ice_id = "::MumbleServer::InvalidListenerException" + +_MumbleServer_InvalidListenerException_t = IcePy.defineException( + "::MumbleServer::InvalidListenerException", + InvalidListenerException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(InvalidListenerException, '_ice_type', _MumbleServer_InvalidListenerException_t) + +__all__ = ["InvalidListenerException", "_MumbleServer_InvalidListenerException_t"] diff --git a/MumbleServer/InvalidSecretException.py b/MumbleServer/InvalidSecretException.py new file mode 100644 index 0000000..884c66d --- /dev/null +++ b/MumbleServer/InvalidSecretException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class InvalidSecretException(ServerException): + """ + This is thrown when you supply the wrong secret in the calling context. + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::InvalidSecretException``. + """ + + _ice_id = "::MumbleServer::InvalidSecretException" + +_MumbleServer_InvalidSecretException_t = IcePy.defineException( + "::MumbleServer::InvalidSecretException", + InvalidSecretException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(InvalidSecretException, '_ice_type', _MumbleServer_InvalidSecretException_t) + +__all__ = ["InvalidSecretException", "_MumbleServer_InvalidSecretException_t"] diff --git a/MumbleServer/InvalidServerException.py b/MumbleServer/InvalidServerException.py new file mode 100644 index 0000000..ab1acf6 --- /dev/null +++ b/MumbleServer/InvalidServerException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class InvalidServerException(ServerException): + """ + This is thrown when you try to do an operation on a server that does not exist. This may happen if someone has removed the server. + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::InvalidServerException``. + """ + + _ice_id = "::MumbleServer::InvalidServerException" + +_MumbleServer_InvalidServerException_t = IcePy.defineException( + "::MumbleServer::InvalidServerException", + InvalidServerException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(InvalidServerException, '_ice_type', _MumbleServer_InvalidServerException_t) + +__all__ = ["InvalidServerException", "_MumbleServer_InvalidServerException_t"] diff --git a/MumbleServer/InvalidSessionException.py b/MumbleServer/InvalidSessionException.py new file mode 100644 index 0000000..33a8eee --- /dev/null +++ b/MumbleServer/InvalidSessionException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class InvalidSessionException(ServerException): + """ + 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`` + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::InvalidSessionException``. + """ + + _ice_id = "::MumbleServer::InvalidSessionException" + +_MumbleServer_InvalidSessionException_t = IcePy.defineException( + "::MumbleServer::InvalidSessionException", + InvalidSessionException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(InvalidSessionException, '_ice_type', _MumbleServer_InvalidSessionException_t) + +__all__ = ["InvalidSessionException", "_MumbleServer_InvalidSessionException_t"] diff --git a/MumbleServer/InvalidTextureException.py b/MumbleServer/InvalidTextureException.py new file mode 100644 index 0000000..695db2b --- /dev/null +++ b/MumbleServer/InvalidTextureException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class InvalidTextureException(ServerException): + """ + This is thrown when you try to set an invalid texture. + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::InvalidTextureException``. + """ + + _ice_id = "::MumbleServer::InvalidTextureException" + +_MumbleServer_InvalidTextureException_t = IcePy.defineException( + "::MumbleServer::InvalidTextureException", + InvalidTextureException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(InvalidTextureException, '_ice_type', _MumbleServer_InvalidTextureException_t) + +__all__ = ["InvalidTextureException", "_MumbleServer_InvalidTextureException_t"] diff --git a/MumbleServer/InvalidUserException.py b/MumbleServer/InvalidUserException.py new file mode 100644 index 0000000..622c20d --- /dev/null +++ b/MumbleServer/InvalidUserException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class InvalidUserException(ServerException): + """ + This is thrown when you specify an invalid userid. + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::InvalidUserException``. + """ + + _ice_id = "::MumbleServer::InvalidUserException" + +_MumbleServer_InvalidUserException_t = IcePy.defineException( + "::MumbleServer::InvalidUserException", + InvalidUserException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(InvalidUserException, '_ice_type', _MumbleServer_InvalidUserException_t) + +__all__ = ["InvalidUserException", "_MumbleServer_InvalidUserException_t"] diff --git a/MumbleServer/LogEntry.py b/MumbleServer/LogEntry.py new file mode 100644 index 0000000..691ddc3 --- /dev/null +++ b/MumbleServer/LogEntry.py @@ -0,0 +1,39 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from dataclasses import dataclass + + +@dataclass(order=True, unsafe_hash=True) +class LogEntry: + """ + A entry in the log. + + Attributes + ---------- + timestamp : int + Timestamp in UNIX time_t + txt : str + The log message. + + Notes + ----- + The Slice compiler generated this dataclass from Slice struct ``::MumbleServer::LogEntry``. + """ + timestamp: int = 0 + txt: str = "" + +_MumbleServer_LogEntry_t = IcePy.defineStruct( + "::MumbleServer::LogEntry", + LogEntry, + (), + ( + ("timestamp", (), IcePy._t_int), + ("txt", (), IcePy._t_string) + )) + +__all__ = ["LogEntry", "_MumbleServer_LogEntry_t"] diff --git a/MumbleServer/LogList.py b/MumbleServer/LogList.py new file mode 100644 index 0000000..0a86894 --- /dev/null +++ b/MumbleServer/LogList.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.LogEntry import _MumbleServer_LogEntry_t + +_MumbleServer_LogList_t = IcePy.defineSequence("::MumbleServer::LogList", (), _MumbleServer_LogEntry_t) + +__all__ = ["_MumbleServer_LogList_t"] diff --git a/MumbleServer/Meta.py b/MumbleServer/Meta.py new file mode 100644 index 0000000..e371b7d --- /dev/null +++ b/MumbleServer/Meta.py @@ -0,0 +1,837 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from Ice.Object import Object + +from Ice.ObjectPrx import ObjectPrx +from Ice.ObjectPrx import checkedCast +from Ice.ObjectPrx import checkedCastAsync +from Ice.ObjectPrx import uncheckedCast + +from Ice.OperationMode import OperationMode + +from MumbleServer.ConfigMap import _MumbleServer_ConfigMap_t + +from MumbleServer.DBState import _MumbleServer_DBState_t + +from MumbleServer.InvalidCallbackException import _MumbleServer_InvalidCallbackException_t + +from MumbleServer.InvalidSecretException import _MumbleServer_InvalidSecretException_t + +from MumbleServer.MetaCallback_forward import _MumbleServer_MetaCallbackPrx_t + +from MumbleServer.Meta_forward import _MumbleServer_MetaPrx_t + +from MumbleServer.ReadOnlyModeException import _MumbleServer_ReadOnlyModeException_t + +from MumbleServer.ServerList import _MumbleServer_ServerList_t + +from MumbleServer.Server_forward import _MumbleServer_ServerPrx_t + +from abc import ABC +from abc import abstractmethod + +from typing import TYPE_CHECKING +from typing import overload + +if TYPE_CHECKING: + from Ice.Current import Current + from MumbleServer.DBState import DBState + from MumbleServer.MetaCallback import MetaCallbackPrx + from MumbleServer.Server import ServerPrx + from collections.abc import Awaitable + from collections.abc import Mapping + from collections.abc import Sequence + + +class MetaPrx(ObjectPrx): + """ + This is the meta interface. It is primarily used for retrieving the :class:`MumbleServer.ServerPrx` interfaces for each individual server. + + Notes + ----- + The Slice compiler generated this proxy class from Slice interface ``::MumbleServer::Meta``. + """ + + def getServer(self, id: int, context: dict[str, str] | None = None) -> ServerPrx | None: + """ + Fetch interface to specific server. + + Parameters + ---------- + id : int + Server ID. See ``Server.getId``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + ServerPrx | None + Interface for specified server, or a null proxy if id is invalid. + """ + return Meta._op_getServer.invoke(self, ((id, ), context)) + + def getServerAsync(self, id: int, context: dict[str, str] | None = None) -> Awaitable[ServerPrx | None]: + """ + Fetch interface to specific server. + + Parameters + ---------- + id : int + Server ID. See ``Server.getId``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[ServerPrx | None] + Interface for specified server, or a null proxy if id is invalid. + """ + return Meta._op_getServer.invokeAsync(self, ((id, ), context)) + + def newServer(self, context: dict[str, str] | None = None) -> ServerPrx | None: + """ + Create a new server. Call ``Server.getId`` on the returned interface to find it's ID. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + ServerPrx | None + Interface for new server. + """ + return Meta._op_newServer.invoke(self, ((), context)) + + def newServerAsync(self, context: dict[str, str] | None = None) -> Awaitable[ServerPrx | None]: + """ + Create a new server. Call ``Server.getId`` on the returned interface to find it's ID. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[ServerPrx | None] + Interface for new server. + """ + return Meta._op_newServer.invokeAsync(self, ((), context)) + + def getBootedServers(self, context: dict[str, str] | None = None) -> list[ServerPrx | None]: + """ + Fetch list of all currently running servers. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + list[ServerPrx | None] + List of interfaces for running servers. + """ + return Meta._op_getBootedServers.invoke(self, ((), context)) + + def getBootedServersAsync(self, context: dict[str, str] | None = None) -> Awaitable[list[ServerPrx | None]]: + """ + Fetch list of all currently running servers. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[list[ServerPrx | None]] + List of interfaces for running servers. + """ + return Meta._op_getBootedServers.invokeAsync(self, ((), context)) + + def getAllServers(self, context: dict[str, str] | None = None) -> list[ServerPrx | None]: + """ + Fetch list of all defined servers. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + list[ServerPrx | None] + List of interfaces for all servers. + """ + return Meta._op_getAllServers.invoke(self, ((), context)) + + def getAllServersAsync(self, context: dict[str, str] | None = None) -> Awaitable[list[ServerPrx | None]]: + """ + Fetch list of all defined servers. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[list[ServerPrx | None]] + List of interfaces for all servers. + """ + return Meta._op_getAllServers.invokeAsync(self, ((), context)) + + def getDefaultConf(self, context: dict[str, str] | None = None) -> dict[str, str]: + """ + Fetch default configuration. This returns the configuration items that were set in the configuration file, or + the built-in default. The individual servers will use these values unless they have been overridden in the + server specific configuration. The only special case is the port, which defaults to the value defined here + + the servers ID - 1 (so that virtual server #1 uses the defined port, server #2 uses port+1 etc). + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + dict[str, str] + Default configuration of the servers. + """ + return Meta._op_getDefaultConf.invoke(self, ((), context)) + + def getDefaultConfAsync(self, context: dict[str, str] | None = None) -> Awaitable[dict[str, str]]: + """ + Fetch default configuration. This returns the configuration items that were set in the configuration file, or + the built-in default. The individual servers will use these values unless they have been overridden in the + server specific configuration. The only special case is the port, which defaults to the value defined here + + the servers ID - 1 (so that virtual server #1 uses the defined port, server #2 uses port+1 etc). + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[dict[str, str]] + Default configuration of the servers. + """ + return Meta._op_getDefaultConf.invokeAsync(self, ((), context)) + + def getVersion(self, context: dict[str, str] | None = None) -> tuple[int, int, int, str]: + """ + Fetch version of the server. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + tuple[int, int, int, str] + + A tuple containing: + - int Major version. + - int Minor version. + - int Patchlevel. + - str Textual representation of version. Note that this may not match the ``major``, ``minor`` and ``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. + """ + return Meta._op_getVersion.invoke(self, ((), context)) + + def getVersionAsync(self, context: dict[str, str] | None = None) -> Awaitable[tuple[int, int, int, str]]: + """ + Fetch version of the server. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[tuple[int, int, int, str]] + + A tuple containing: + - int Major version. + - int Minor version. + - int Patchlevel. + - str Textual representation of version. Note that this may not match the ``major``, ``minor`` and ``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. + """ + return Meta._op_getVersion.invokeAsync(self, ((), context)) + + def addCallback(self, cb: MetaCallbackPrx | None, context: dict[str, str] | None = None) -> None: + """ + Add a callback. The callback will receive notifications when servers are started or stopped. + + Parameters + ---------- + cb : MetaCallbackPrx | None + Callback interface which will receive notifications. + context : dict[str, str] + The request context for the invocation. + """ + return Meta._op_addCallback.invoke(self, ((cb, ), context)) + + def addCallbackAsync(self, cb: MetaCallbackPrx | None, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Add a callback. The callback will receive notifications when servers are started or stopped. + + Parameters + ---------- + cb : MetaCallbackPrx | None + Callback interface which will receive notifications. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Meta._op_addCallback.invokeAsync(self, ((cb, ), context)) + + def removeCallback(self, cb: MetaCallbackPrx | None, context: dict[str, str] | None = None) -> None: + """ + Remove a callback. + + Parameters + ---------- + cb : MetaCallbackPrx | None + Callback interface to be removed. + context : dict[str, str] + The request context for the invocation. + """ + return Meta._op_removeCallback.invoke(self, ((cb, ), context)) + + def removeCallbackAsync(self, cb: MetaCallbackPrx | None, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Remove a callback. + + Parameters + ---------- + cb : MetaCallbackPrx | None + Callback interface to be removed. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Meta._op_removeCallback.invokeAsync(self, ((cb, ), context)) + + def getUptime(self, context: dict[str, str] | None = None) -> int: + """ + Get the server's uptime. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + Uptime of the server in seconds + """ + return Meta._op_getUptime.invoke(self, ((), context)) + + def getUptimeAsync(self, context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Get the server's uptime. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + Uptime of the server in seconds + """ + return Meta._op_getUptime.invokeAsync(self, ((), context)) + + def getSlice(self, context: dict[str, str] | None = None) -> str: + """ + Get slice file. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + str + Contents of the slice file server compiled with. + """ + return Meta._op_getSlice.invoke(self, ((), context)) + + def getSliceAsync(self, context: dict[str, str] | None = None) -> Awaitable[str]: + """ + Get slice file. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[str] + Contents of the slice file server compiled with. + """ + return Meta._op_getSlice.invokeAsync(self, ((), context)) + + def getAssumedDatabaseState(self, context: dict[str, str] | None = None) -> DBState: + return Meta._op_getAssumedDatabaseState.invoke(self, ((), context)) + + def getAssumedDatabaseStateAsync(self, context: dict[str, str] | None = None) -> Awaitable[DBState]: + return Meta._op_getAssumedDatabaseState.invokeAsync(self, ((), context)) + + def setAssumedDatabaseState(self, state: DBState, context: dict[str, str] | None = None) -> None: + """ + Sets the assumed state of the underlying database + + Parameters + ---------- + state : DBState + context : dict[str, str] + The request context for the invocation. + """ + return Meta._op_setAssumedDatabaseState.invoke(self, ((state, ), context)) + + def setAssumedDatabaseStateAsync(self, state: DBState, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Sets the assumed state of the underlying database + + Parameters + ---------- + state : DBState + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Meta._op_setAssumedDatabaseState.invokeAsync(self, ((state, ), context)) + + @staticmethod + def checkedCast( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> MetaPrx | None: + return checkedCast(MetaPrx, proxy, facet, context) + + @staticmethod + def checkedCastAsync( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> Awaitable[MetaPrx | None ]: + return checkedCastAsync(MetaPrx, proxy, facet, context) + + @overload + @staticmethod + def uncheckedCast(proxy: ObjectPrx, facet: str | None = None) -> MetaPrx: + ... + + @overload + @staticmethod + def uncheckedCast(proxy: None, facet: str | None = None) -> None: + ... + + @staticmethod + def uncheckedCast(proxy: ObjectPrx | None, facet: str | None = None) -> MetaPrx | None: + return uncheckedCast(MetaPrx, proxy, facet) + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::Meta" + +IcePy.defineProxy("::MumbleServer::Meta", MetaPrx) + +class Meta(Object, ABC): + """ + This is the meta interface. It is primarily used for retrieving the :class:`MumbleServer.ServerPrx` interfaces for each individual server. + + Notes + ----- + The Slice compiler generated this skeleton class from Slice interface ``::MumbleServer::Meta``. + """ + + _ice_ids: Sequence[str] = ("::Ice::Object", "::MumbleServer::Meta", ) + _op_getServer: IcePy.Operation + _op_newServer: IcePy.Operation + _op_getBootedServers: IcePy.Operation + _op_getAllServers: IcePy.Operation + _op_getDefaultConf: IcePy.Operation + _op_getVersion: IcePy.Operation + _op_addCallback: IcePy.Operation + _op_removeCallback: IcePy.Operation + _op_getUptime: IcePy.Operation + _op_getSlice: IcePy.Operation + _op_getAssumedDatabaseState: IcePy.Operation + _op_setAssumedDatabaseState: IcePy.Operation + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::Meta" + + @abstractmethod + def getServer(self, id: int, current: Current) -> ServerPrx | None | Awaitable[ServerPrx | None]: + """ + Fetch interface to specific server. + + Parameters + ---------- + id : int + Server ID. See ``Server.getId``. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + ServerPrx | None | Awaitable[ServerPrx | None] + Interface for specified server, or a null proxy if id is invalid. + """ + pass + + @abstractmethod + def newServer(self, current: Current) -> ServerPrx | None | Awaitable[ServerPrx | None]: + """ + Create a new server. Call ``Server.getId`` on the returned interface to find it's ID. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + ServerPrx | None | Awaitable[ServerPrx | None] + Interface for new server. + """ + pass + + @abstractmethod + def getBootedServers(self, current: Current) -> Sequence[ServerPrx | None] | Awaitable[Sequence[ServerPrx | None]]: + """ + Fetch list of all currently running servers. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Sequence[ServerPrx | None] | Awaitable[Sequence[ServerPrx | None]] + List of interfaces for running servers. + """ + pass + + @abstractmethod + def getAllServers(self, current: Current) -> Sequence[ServerPrx | None] | Awaitable[Sequence[ServerPrx | None]]: + """ + Fetch list of all defined servers. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Sequence[ServerPrx | None] | Awaitable[Sequence[ServerPrx | None]] + List of interfaces for all servers. + """ + pass + + @abstractmethod + def getDefaultConf(self, current: Current) -> Mapping[str, str] | Awaitable[Mapping[str, str]]: + """ + Fetch default configuration. This returns the configuration items that were set in the configuration file, or + the built-in default. The individual servers will use these values unless they have been overridden in the + server specific configuration. The only special case is the port, which defaults to the value defined here + + the servers ID - 1 (so that virtual server #1 uses the defined port, server #2 uses port+1 etc). + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Mapping[str, str] | Awaitable[Mapping[str, str]] + Default configuration of the servers. + """ + pass + + @abstractmethod + def getVersion(self, current: Current) -> tuple[int, int, int, str] | Awaitable[tuple[int, int, int, str]]: + """ + Fetch version of the server. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + tuple[int, int, int, str] | Awaitable[tuple[int, int, int, str]] + + A tuple containing: + - int Major version. + - int Minor version. + - int Patchlevel. + - str Textual representation of version. Note that this may not match the ``major``, ``minor`` and ``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. + """ + pass + + @abstractmethod + def addCallback(self, cb: MetaCallbackPrx | None, current: Current) -> None | Awaitable[None]: + """ + Add a callback. The callback will receive notifications when servers are started or stopped. + + Parameters + ---------- + cb : MetaCallbackPrx | None + Callback interface which will receive notifications. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def removeCallback(self, cb: MetaCallbackPrx | None, current: Current) -> None | Awaitable[None]: + """ + Remove a callback. + + Parameters + ---------- + cb : MetaCallbackPrx | None + Callback interface to be removed. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def getUptime(self, current: Current) -> int | Awaitable[int]: + """ + Get the server's uptime. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + Uptime of the server in seconds + """ + pass + + @abstractmethod + def getSlice(self, current: Current) -> str | Awaitable[str]: + """ + Get slice file. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + str | Awaitable[str] + Contents of the slice file server compiled with. + """ + pass + + @abstractmethod + def getAssumedDatabaseState(self, current: Current) -> DBState | Awaitable[DBState]: + pass + + @abstractmethod + def setAssumedDatabaseState(self, state: DBState, current: Current) -> None | Awaitable[None]: + """ + Sets the assumed state of the underlying database + + Parameters + ---------- + state : DBState + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + +Meta._op_getServer = IcePy.Operation( + "getServer", + "getServer", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + ((), _MumbleServer_ServerPrx_t, False, 0), + (_MumbleServer_InvalidSecretException_t,)) + +Meta._op_newServer = IcePy.Operation( + "newServer", + "newServer", + OperationMode.Normal, + None, + (), + (), + (), + ((), _MumbleServer_ServerPrx_t, False, 0), + (_MumbleServer_InvalidSecretException_t,)) + +Meta._op_getBootedServers = IcePy.Operation( + "getBootedServers", + "getBootedServers", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), _MumbleServer_ServerList_t, False, 0), + (_MumbleServer_InvalidSecretException_t,)) + +Meta._op_getAllServers = IcePy.Operation( + "getAllServers", + "getAllServers", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), _MumbleServer_ServerList_t, False, 0), + (_MumbleServer_InvalidSecretException_t,)) + +Meta._op_getDefaultConf = IcePy.Operation( + "getDefaultConf", + "getDefaultConf", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), _MumbleServer_ConfigMap_t, False, 0), + (_MumbleServer_InvalidSecretException_t,)) + +Meta._op_getVersion = IcePy.Operation( + "getVersion", + "getVersion", + OperationMode.Idempotent, + None, + (), + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0)), + None, + ()) + +Meta._op_addCallback = IcePy.Operation( + "addCallback", + "addCallback", + OperationMode.Normal, + None, + (), + (((), _MumbleServer_MetaCallbackPrx_t, False, 0),), + (), + None, + (_MumbleServer_InvalidCallbackException_t, _MumbleServer_InvalidSecretException_t)) + +Meta._op_removeCallback = IcePy.Operation( + "removeCallback", + "removeCallback", + OperationMode.Normal, + None, + (), + (((), _MumbleServer_MetaCallbackPrx_t, False, 0),), + (), + None, + (_MumbleServer_InvalidCallbackException_t, _MumbleServer_InvalidSecretException_t)) + +Meta._op_getUptime = IcePy.Operation( + "getUptime", + "getUptime", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), IcePy._t_int, False, 0), + ()) + +Meta._op_getSlice = IcePy.Operation( + "getSlice", + "getSlice", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), IcePy._t_string, False, 0), + ()) + +Meta._op_getAssumedDatabaseState = IcePy.Operation( + "getAssumedDatabaseState", + "getAssumedDatabaseState", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), _MumbleServer_DBState_t, False, 0), + (_MumbleServer_InvalidSecretException_t,)) + +Meta._op_setAssumedDatabaseState = IcePy.Operation( + "setAssumedDatabaseState", + "setAssumedDatabaseState", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_DBState_t, False, 0),), + (), + None, + (_MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +__all__ = ["Meta", "MetaPrx", "_MumbleServer_MetaPrx_t"] diff --git a/MumbleServer/MetaCallback.py b/MumbleServer/MetaCallback.py new file mode 100644 index 0000000..f9cee4c --- /dev/null +++ b/MumbleServer/MetaCallback.py @@ -0,0 +1,242 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from Ice.Object import Object + +from Ice.ObjectPrx import ObjectPrx +from Ice.ObjectPrx import checkedCast +from Ice.ObjectPrx import checkedCastAsync +from Ice.ObjectPrx import uncheckedCast + +from Ice.OperationMode import OperationMode + +from MumbleServer.MetaCallback_forward import _MumbleServer_MetaCallbackPrx_t + +from MumbleServer.Server_forward import _MumbleServer_ServerPrx_t + +from abc import ABC +from abc import abstractmethod + +from typing import TYPE_CHECKING +from typing import overload + +if TYPE_CHECKING: + from Ice.Current import Current + from MumbleServer.Server import ServerPrx + from collections.abc import Awaitable + from collections.abc import Sequence + + +class MetaCallbackPrx(ObjectPrx): + """ + Callback interface for Meta. You can supply an implementation of this to receive notifications + when servers are stopped or started. + If an added callback ever throws an exception or goes away, it will be automatically removed. + Please note that all callbacks are done asynchronously; the server does not wait for the callback to + complete before continuing processing. + + Notes + ----- + The Slice compiler generated this proxy class from Slice interface ``::MumbleServer::MetaCallback``. + + See Also + -------- + :class:`MumbleServer.ServerCallbackPrx` + ``Meta.addCallback`` + """ + + def started(self, srv: ServerPrx | None, context: dict[str, str] | None = None) -> None: + """ + Called when a server is started. The server is up and running when this event is sent, so all methods that + need a running server will work. + + Parameters + ---------- + srv : ServerPrx | None + Interface for started server. + context : dict[str, str] + The request context for the invocation. + """ + return MetaCallback._op_started.invoke(self, ((srv, ), context)) + + def startedAsync(self, srv: ServerPrx | None, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Called when a server is started. The server is up and running when this event is sent, so all methods that + need a running server will work. + + Parameters + ---------- + srv : ServerPrx | None + Interface for started server. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return MetaCallback._op_started.invokeAsync(self, ((srv, ), context)) + + def stopped(self, srv: ServerPrx | None, context: dict[str, str] | None = None) -> None: + """ + Called when a server is stopped. The server is already stopped when this event is sent, so no methods that + need a running server will work. + + Parameters + ---------- + srv : ServerPrx | None + Interface for started server. + context : dict[str, str] + The request context for the invocation. + """ + return MetaCallback._op_stopped.invoke(self, ((srv, ), context)) + + def stoppedAsync(self, srv: ServerPrx | None, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Called when a server is stopped. The server is already stopped when this event is sent, so no methods that + need a running server will work. + + Parameters + ---------- + srv : ServerPrx | None + Interface for started server. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return MetaCallback._op_stopped.invokeAsync(self, ((srv, ), context)) + + @staticmethod + def checkedCast( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> MetaCallbackPrx | None: + return checkedCast(MetaCallbackPrx, proxy, facet, context) + + @staticmethod + def checkedCastAsync( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> Awaitable[MetaCallbackPrx | None ]: + return checkedCastAsync(MetaCallbackPrx, proxy, facet, context) + + @overload + @staticmethod + def uncheckedCast(proxy: ObjectPrx, facet: str | None = None) -> MetaCallbackPrx: + ... + + @overload + @staticmethod + def uncheckedCast(proxy: None, facet: str | None = None) -> None: + ... + + @staticmethod + def uncheckedCast(proxy: ObjectPrx | None, facet: str | None = None) -> MetaCallbackPrx | None: + return uncheckedCast(MetaCallbackPrx, proxy, facet) + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::MetaCallback" + +IcePy.defineProxy("::MumbleServer::MetaCallback", MetaCallbackPrx) + +class MetaCallback(Object, ABC): + """ + Callback interface for Meta. You can supply an implementation of this to receive notifications + when servers are stopped or started. + If an added callback ever throws an exception or goes away, it will be automatically removed. + Please note that all callbacks are done asynchronously; the server does not wait for the callback to + complete before continuing processing. + + Notes + ----- + The Slice compiler generated this skeleton class from Slice interface ``::MumbleServer::MetaCallback``. + + See Also + -------- + :class:`MumbleServer.ServerCallbackPrx` + ``Meta.addCallback`` + """ + + _ice_ids: Sequence[str] = ("::Ice::Object", "::MumbleServer::MetaCallback", ) + _op_started: IcePy.Operation + _op_stopped: IcePy.Operation + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::MetaCallback" + + @abstractmethod + def started(self, srv: ServerPrx | None, current: Current) -> None | Awaitable[None]: + """ + Called when a server is started. The server is up and running when this event is sent, so all methods that + need a running server will work. + + Parameters + ---------- + srv : ServerPrx | None + Interface for started server. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def stopped(self, srv: ServerPrx | None, current: Current) -> None | Awaitable[None]: + """ + Called when a server is stopped. The server is already stopped when this event is sent, so no methods that + need a running server will work. + + Parameters + ---------- + srv : ServerPrx | None + Interface for started server. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + +MetaCallback._op_started = IcePy.Operation( + "started", + "started", + OperationMode.Normal, + None, + (), + (((), _MumbleServer_ServerPrx_t, False, 0),), + (), + None, + ()) + +MetaCallback._op_stopped = IcePy.Operation( + "stopped", + "stopped", + OperationMode.Normal, + None, + (), + (((), _MumbleServer_ServerPrx_t, False, 0),), + (), + None, + ()) + +__all__ = ["MetaCallback", "MetaCallbackPrx", "_MumbleServer_MetaCallbackPrx_t"] diff --git a/MumbleServer/MetaCallback_forward.py b/MumbleServer/MetaCallback_forward.py new file mode 100644 index 0000000..d92cc64 --- /dev/null +++ b/MumbleServer/MetaCallback_forward.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_MetaCallbackPrx_t = IcePy.declareProxy("::MumbleServer::MetaCallback") + +__all__ = ["_MumbleServer_MetaCallbackPrx_t"] \ No newline at end of file diff --git a/MumbleServer/Meta_forward.py b/MumbleServer/Meta_forward.py new file mode 100644 index 0000000..e5970d8 --- /dev/null +++ b/MumbleServer/Meta_forward.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_MetaPrx_t = IcePy.declareProxy("::MumbleServer::Meta") + +__all__ = ["_MumbleServer_MetaPrx_t"] \ No newline at end of file diff --git a/MumbleServer/NameList.py b/MumbleServer/NameList.py new file mode 100644 index 0000000..7ff7202 --- /dev/null +++ b/MumbleServer/NameList.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_NameList_t = IcePy.defineSequence("::MumbleServer::NameList", (), IcePy._t_string) + +__all__ = ["_MumbleServer_NameList_t"] diff --git a/MumbleServer/NameMap.py b/MumbleServer/NameMap.py new file mode 100644 index 0000000..98c0c35 --- /dev/null +++ b/MumbleServer/NameMap.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_NameMap_t = IcePy.defineDictionary("::MumbleServer::NameMap", (), IcePy._t_int, IcePy._t_string) + +__all__ = ["_MumbleServer_NameMap_t"] diff --git a/MumbleServer/NestingLimitException.py b/MumbleServer/NestingLimitException.py new file mode 100644 index 0000000..c9a243e --- /dev/null +++ b/MumbleServer/NestingLimitException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class NestingLimitException(ServerException): + """ + This is thrown when the channel operation would exceed the channel nesting limit + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::NestingLimitException``. + """ + + _ice_id = "::MumbleServer::NestingLimitException" + +_MumbleServer_NestingLimitException_t = IcePy.defineException( + "::MumbleServer::NestingLimitException", + NestingLimitException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(NestingLimitException, '_ice_type', _MumbleServer_NestingLimitException_t) + +__all__ = ["NestingLimitException", "_MumbleServer_NestingLimitException_t"] diff --git a/MumbleServer/NetAddress.py b/MumbleServer/NetAddress.py new file mode 100644 index 0000000..e9134aa --- /dev/null +++ b/MumbleServer/NetAddress.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_NetAddress_t = IcePy.defineSequence("::MumbleServer::NetAddress", (), IcePy._t_byte) + +__all__ = ["_MumbleServer_NetAddress_t"] diff --git a/MumbleServer/PermissionBan.py b/MumbleServer/PermissionBan.py new file mode 100644 index 0000000..b27136f --- /dev/null +++ b/MumbleServer/PermissionBan.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionBan = 131072 +""" +Ban user from server. Only valid on root channel. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionBan``. +""" + +__all__ = ["PermissionBan"] diff --git a/MumbleServer/PermissionEnter.py b/MumbleServer/PermissionEnter.py new file mode 100644 index 0000000..7b6d2b1 --- /dev/null +++ b/MumbleServer/PermissionEnter.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionEnter = 4 +""" +Enter channel. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionEnter``. +""" + +__all__ = ["PermissionEnter"] diff --git a/MumbleServer/PermissionKick.py b/MumbleServer/PermissionKick.py new file mode 100644 index 0000000..2adb3a8 --- /dev/null +++ b/MumbleServer/PermissionKick.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionKick = 65536 +""" +Kick user from server. Only valid on root channel. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionKick``. +""" + +__all__ = ["PermissionKick"] diff --git a/MumbleServer/PermissionLinkChannel.py b/MumbleServer/PermissionLinkChannel.py new file mode 100644 index 0000000..87e3fe4 --- /dev/null +++ b/MumbleServer/PermissionLinkChannel.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionLinkChannel = 128 +""" +Link this channel. You need this permission in both the source and destination channel to link channels, or in either channel to unlink them. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionLinkChannel``. +""" + +__all__ = ["PermissionLinkChannel"] diff --git a/MumbleServer/PermissionMakeChannel.py b/MumbleServer/PermissionMakeChannel.py new file mode 100644 index 0000000..28814bf --- /dev/null +++ b/MumbleServer/PermissionMakeChannel.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionMakeChannel = 64 +""" +Make new channel as a subchannel of this channel. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionMakeChannel``. +""" + +__all__ = ["PermissionMakeChannel"] diff --git a/MumbleServer/PermissionMakeTempChannel.py b/MumbleServer/PermissionMakeTempChannel.py new file mode 100644 index 0000000..28abfe7 --- /dev/null +++ b/MumbleServer/PermissionMakeTempChannel.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionMakeTempChannel = 1024 +""" +Make new temporary channel as a subchannel of this channel. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionMakeTempChannel``. +""" + +__all__ = ["PermissionMakeTempChannel"] diff --git a/MumbleServer/PermissionMove.py b/MumbleServer/PermissionMove.py new file mode 100644 index 0000000..b979bf4 --- /dev/null +++ b/MumbleServer/PermissionMove.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionMove = 32 +""" +Move users from channel. You need this permission in both the source and destination channel to move another user. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionMove``. +""" + +__all__ = ["PermissionMove"] diff --git a/MumbleServer/PermissionMuteDeafen.py b/MumbleServer/PermissionMuteDeafen.py new file mode 100644 index 0000000..fa60b94 --- /dev/null +++ b/MumbleServer/PermissionMuteDeafen.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionMuteDeafen = 16 +""" +Mute and deafen other users in this channel. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionMuteDeafen``. +""" + +__all__ = ["PermissionMuteDeafen"] diff --git a/MumbleServer/PermissionRegister.py b/MumbleServer/PermissionRegister.py new file mode 100644 index 0000000..ee21b7b --- /dev/null +++ b/MumbleServer/PermissionRegister.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionRegister = 262144 +""" +Register and unregister users. Only valid on root channel. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionRegister``. +""" + +__all__ = ["PermissionRegister"] diff --git a/MumbleServer/PermissionRegisterSelf.py b/MumbleServer/PermissionRegisterSelf.py new file mode 100644 index 0000000..f8ff9d1 --- /dev/null +++ b/MumbleServer/PermissionRegisterSelf.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionRegisterSelf = 524288 +""" +Register and unregister users. Only valid on root channel. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionRegisterSelf``. +""" + +__all__ = ["PermissionRegisterSelf"] diff --git a/MumbleServer/PermissionSpeak.py b/MumbleServer/PermissionSpeak.py new file mode 100644 index 0000000..2787999 --- /dev/null +++ b/MumbleServer/PermissionSpeak.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionSpeak = 8 +""" +Speak in channel. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionSpeak``. +""" + +__all__ = ["PermissionSpeak"] diff --git a/MumbleServer/PermissionTextMessage.py b/MumbleServer/PermissionTextMessage.py new file mode 100644 index 0000000..0d63a2b --- /dev/null +++ b/MumbleServer/PermissionTextMessage.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionTextMessage = 512 +""" +Send text message to channel. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionTextMessage``. +""" + +__all__ = ["PermissionTextMessage"] diff --git a/MumbleServer/PermissionTraverse.py b/MumbleServer/PermissionTraverse.py new file mode 100644 index 0000000..d84f0a5 --- /dev/null +++ b/MumbleServer/PermissionTraverse.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionTraverse = 2 +""" +Traverse channel. Without this, a client cannot reach subchannels, no matter which privileges he has there. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionTraverse``. +""" + +__all__ = ["PermissionTraverse"] diff --git a/MumbleServer/PermissionWhisper.py b/MumbleServer/PermissionWhisper.py new file mode 100644 index 0000000..e71123f --- /dev/null +++ b/MumbleServer/PermissionWhisper.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionWhisper = 256 +""" +Whisper to channel. This is different from Speak, so you can set up different permissions. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionWhisper``. +""" + +__all__ = ["PermissionWhisper"] diff --git a/MumbleServer/PermissionWrite.py b/MumbleServer/PermissionWrite.py new file mode 100644 index 0000000..24af707 --- /dev/null +++ b/MumbleServer/PermissionWrite.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +PermissionWrite = 1 +""" +Write access to channel control. Implies all other permissions (except Speak). + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::PermissionWrite``. +""" + +__all__ = ["PermissionWrite"] diff --git a/MumbleServer/ReadOnlyModeException.py b/MumbleServer/ReadOnlyModeException.py new file mode 100644 index 0000000..842defe --- /dev/null +++ b/MumbleServer/ReadOnlyModeException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class ReadOnlyModeException(ServerException): + """ + This is thrown when the server has its database in read-only mode and whatever you requested is incompatible with that. + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::ReadOnlyModeException``. + """ + + _ice_id = "::MumbleServer::ReadOnlyModeException" + +_MumbleServer_ReadOnlyModeException_t = IcePy.defineException( + "::MumbleServer::ReadOnlyModeException", + ReadOnlyModeException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(ReadOnlyModeException, '_ice_type', _MumbleServer_ReadOnlyModeException_t) + +__all__ = ["ReadOnlyModeException", "_MumbleServer_ReadOnlyModeException_t"] diff --git a/MumbleServer/ResetUserContent.py b/MumbleServer/ResetUserContent.py new file mode 100644 index 0000000..f8846d8 --- /dev/null +++ b/MumbleServer/ResetUserContent.py @@ -0,0 +1,18 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + + +ResetUserContent = 1048576 +""" +Reset the comment or avatar of a user. Only valid on root channel. + +Notes +----- + The Slice compiler generated this constant from Slice constant ``::MumbleServer::ResetUserContent``. +""" + +__all__ = ["ResetUserContent"] diff --git a/MumbleServer/Server.py b/MumbleServer/Server.py new file mode 100644 index 0000000..8d33a11 --- /dev/null +++ b/MumbleServer/Server.py @@ -0,0 +1,4209 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from Ice.Object import Object + +from Ice.ObjectPrx import ObjectPrx +from Ice.ObjectPrx import checkedCast +from Ice.ObjectPrx import checkedCastAsync +from Ice.ObjectPrx import uncheckedCast + +from Ice.OperationMode import OperationMode + +from MumbleServer.ACLList import _MumbleServer_ACLList_t + +from MumbleServer.BanList import _MumbleServer_BanList_t + +from MumbleServer.CertificateList import _MumbleServer_CertificateList_t + +from MumbleServer.Channel import _MumbleServer_Channel_t + +from MumbleServer.ChannelMap import _MumbleServer_ChannelMap_t + +from MumbleServer.ConfigMap import _MumbleServer_ConfigMap_t + +from MumbleServer.GroupList import _MumbleServer_GroupList_t + +from MumbleServer.IdList import _MumbleServer_IdList_t + +from MumbleServer.IdMap import _MumbleServer_IdMap_t + +from MumbleServer.IntList import _MumbleServer_IntList_t + +from MumbleServer.InvalidCallbackException import _MumbleServer_InvalidCallbackException_t + +from MumbleServer.InvalidChannelException import _MumbleServer_InvalidChannelException_t + +from MumbleServer.InvalidInputDataException import _MumbleServer_InvalidInputDataException_t + +from MumbleServer.InvalidSecretException import _MumbleServer_InvalidSecretException_t + +from MumbleServer.InvalidSessionException import _MumbleServer_InvalidSessionException_t + +from MumbleServer.InvalidTextureException import _MumbleServer_InvalidTextureException_t + +from MumbleServer.InvalidUserException import _MumbleServer_InvalidUserException_t + +from MumbleServer.LogList import _MumbleServer_LogList_t + +from MumbleServer.NameList import _MumbleServer_NameList_t + +from MumbleServer.NameMap import _MumbleServer_NameMap_t + +from MumbleServer.NestingLimitException import _MumbleServer_NestingLimitException_t + +from MumbleServer.ReadOnlyModeException import _MumbleServer_ReadOnlyModeException_t + +from MumbleServer.ServerAuthenticator_forward import _MumbleServer_ServerAuthenticatorPrx_t + +from MumbleServer.ServerBootedException import _MumbleServer_ServerBootedException_t + +from MumbleServer.ServerCallback_forward import _MumbleServer_ServerCallbackPrx_t + +from MumbleServer.ServerContextCallback_forward import _MumbleServer_ServerContextCallbackPrx_t + +from MumbleServer.ServerFailureException import _MumbleServer_ServerFailureException_t + +from MumbleServer.Server_forward import _MumbleServer_ServerPrx_t + +from MumbleServer.Texture import _MumbleServer_Texture_t + +from MumbleServer.Tree_forward import _MumbleServer_Tree_t + +from MumbleServer.User import _MumbleServer_User_t + +from MumbleServer.UserInfoMap import _MumbleServer_UserInfoMap_t + +from MumbleServer.UserMap import _MumbleServer_UserMap_t + +from MumbleServer.WriteOnlyException import _MumbleServer_WriteOnlyException_t + +from abc import ABC +from abc import abstractmethod + +from typing import TYPE_CHECKING +from typing import overload + +if TYPE_CHECKING: + from Ice.Current import Current + from MumbleServer.ACL import ACL + from MumbleServer.Ban import Ban + from MumbleServer.Channel import Channel + from MumbleServer.Group import Group + from MumbleServer.LogEntry import LogEntry + from MumbleServer.ServerAuthenticator import ServerAuthenticatorPrx + from MumbleServer.ServerCallback import ServerCallbackPrx + from MumbleServer.ServerContextCallback import ServerContextCallbackPrx + from MumbleServer.Tree import Tree + from MumbleServer.User import User + from MumbleServer.UserInfo import UserInfo + from collections.abc import Awaitable + from collections.abc import Buffer + from collections.abc import Mapping + from collections.abc import Sequence + + +class ServerPrx(ObjectPrx): + """ + 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 :class:`MumbleServer.MetaPrx`. + + Notes + ----- + The Slice compiler generated this proxy class from Slice interface ``::MumbleServer::Server``. + """ + + def isRunning(self, context: dict[str, str] | None = None) -> bool: + """ + Shows if the server currently running (accepting users). + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + bool + Run-state of server. + """ + return Server._op_isRunning.invoke(self, ((), context)) + + def isRunningAsync(self, context: dict[str, str] | None = None) -> Awaitable[bool]: + """ + Shows if the server currently running (accepting users). + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[bool] + Run-state of server. + """ + return Server._op_isRunning.invokeAsync(self, ((), context)) + + def start(self, context: dict[str, str] | None = None) -> None: + """ + Start server. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_start.invoke(self, ((), context)) + + def startAsync(self, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Start server. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_start.invokeAsync(self, ((), context)) + + def stop(self, context: dict[str, str] | None = None) -> None: + """ + Stop server. + Note: Server will be restarted on application restart unless explicitly disabled + with setConf("boot", false) + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_stop.invoke(self, ((), context)) + + def stopAsync(self, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Stop server. + Note: Server will be restarted on application restart unless explicitly disabled + with setConf("boot", false) + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_stop.invokeAsync(self, ((), context)) + + def delete(self, context: dict[str, str] | None = None) -> None: + """ + Delete server and all it's configuration. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_delete.invoke(self, ((), context)) + + def deleteAsync(self, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Delete server and all it's configuration. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_delete.invokeAsync(self, ((), context)) + + def id(self, context: dict[str, str] | None = None) -> int: + """ + Fetch the server id. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + Unique server id. + """ + return Server._op_id.invoke(self, ((), context)) + + def idAsync(self, context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Fetch the server id. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + Unique server id. + """ + return Server._op_id.invokeAsync(self, ((), context)) + + def addCallback(self, cb: ServerCallbackPrx | None, context: dict[str, str] | None = None) -> None: + """ + Add a callback. The callback will receive notifications about changes to users and channels. + + Parameters + ---------- + cb : ServerCallbackPrx | None + Callback interface which will receive notifications. + context : dict[str, str] + The request context for the invocation. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.removeCallbackAsync` + """ + return Server._op_addCallback.invoke(self, ((cb, ), context)) + + def addCallbackAsync(self, cb: ServerCallbackPrx | None, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Add a callback. The callback will receive notifications about changes to users and channels. + + Parameters + ---------- + cb : ServerCallbackPrx | None + Callback interface which will receive notifications. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.removeCallbackAsync` + """ + return Server._op_addCallback.invokeAsync(self, ((cb, ), context)) + + def removeCallback(self, cb: ServerCallbackPrx | None, context: dict[str, str] | None = None) -> None: + """ + Remove a callback. + + Parameters + ---------- + cb : ServerCallbackPrx | None + Callback interface to be removed. + context : dict[str, str] + The request context for the invocation. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.addCallbackAsync` + """ + return Server._op_removeCallback.invoke(self, ((cb, ), context)) + + def removeCallbackAsync(self, cb: ServerCallbackPrx | None, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Remove a callback. + + Parameters + ---------- + cb : ServerCallbackPrx | None + Callback interface to be removed. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.addCallbackAsync` + """ + return Server._op_removeCallback.invokeAsync(self, ((cb, ), context)) + + def setAuthenticator(self, auth: ServerAuthenticatorPrx | None, context: dict[str, str] | None = None) -> None: + """ + Set external authenticator. If set, all authentications from clients are forwarded to this + proxy. + + Parameters + ---------- + auth : ServerAuthenticatorPrx | None + Authenticator object to perform subsequent authentications. + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_setAuthenticator.invoke(self, ((auth, ), context)) + + def setAuthenticatorAsync(self, auth: ServerAuthenticatorPrx | None, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Set external authenticator. If set, all authentications from clients are forwarded to this + proxy. + + Parameters + ---------- + auth : ServerAuthenticatorPrx | None + Authenticator object to perform subsequent authentications. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_setAuthenticator.invokeAsync(self, ((auth, ), context)) + + def getConf(self, key: str, context: dict[str, str] | None = None) -> str: + """ + Retrieve configuration item. + + Parameters + ---------- + key : str + Configuration key. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + str + Configuration value. If this is empty, see ``Meta.getDefaultConf`` + """ + return Server._op_getConf.invoke(self, ((key, ), context)) + + def getConfAsync(self, key: str, context: dict[str, str] | None = None) -> Awaitable[str]: + """ + Retrieve configuration item. + + Parameters + ---------- + key : str + Configuration key. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[str] + Configuration value. If this is empty, see ``Meta.getDefaultConf`` + """ + return Server._op_getConf.invokeAsync(self, ((key, ), context)) + + def getAllConf(self, context: dict[str, str] | None = None) -> dict[str, str]: + """ + Retrieve all configuration items. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + dict[str, str] + All configured values. If a value isn't set here, the value from ``Meta.getDefaultConf`` is used. + """ + return Server._op_getAllConf.invoke(self, ((), context)) + + def getAllConfAsync(self, context: dict[str, str] | None = None) -> Awaitable[dict[str, str]]: + """ + Retrieve all configuration items. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[dict[str, str]] + All configured values. If a value isn't set here, the value from ``Meta.getDefaultConf`` is used. + """ + return Server._op_getAllConf.invokeAsync(self, ((), context)) + + def setConf(self, key: str, value: str, context: dict[str, str] | None = None) -> None: + """ + Set a configuration item. + + Parameters + ---------- + key : str + Configuration key. + value : str + Configuration value. + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_setConf.invoke(self, ((key, value), context)) + + def setConfAsync(self, key: str, value: str, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Set a configuration item. + + Parameters + ---------- + key : str + Configuration key. + value : str + Configuration value. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_setConf.invokeAsync(self, ((key, value), context)) + + def setSuperuserPassword(self, pw: str, context: dict[str, str] | None = None) -> None: + """ + Set superuser password. This is just a convenience for using :meth:`MumbleServer.ServerPrx.updateRegistrationAsync` on user id 0. + + Parameters + ---------- + pw : str + Password. + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_setSuperuserPassword.invoke(self, ((pw, ), context)) + + def setSuperuserPasswordAsync(self, pw: str, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Set superuser password. This is just a convenience for using :meth:`MumbleServer.ServerPrx.updateRegistrationAsync` on user id 0. + + Parameters + ---------- + pw : str + Password. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_setSuperuserPassword.invokeAsync(self, ((pw, ), context)) + + def getLog(self, first: int, last: int, context: dict[str, str] | None = None) -> list[LogEntry]: + """ + Fetch log entries. + + Parameters + ---------- + first : int + Lowest numbered entry to fetch. 0 is the most recent item. + last : int + Last entry to fetch. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + list[LogEntry] + List of log entries. + """ + return Server._op_getLog.invoke(self, ((first, last), context)) + + def getLogAsync(self, first: int, last: int, context: dict[str, str] | None = None) -> Awaitable[list[LogEntry]]: + """ + Fetch log entries. + + Parameters + ---------- + first : int + Lowest numbered entry to fetch. 0 is the most recent item. + last : int + Last entry to fetch. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[list[LogEntry]] + List of log entries. + """ + return Server._op_getLog.invokeAsync(self, ((first, last), context)) + + def getLogLen(self, context: dict[str, str] | None = None) -> int: + """ + Fetch length of log + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + Number of entries in log + """ + return Server._op_getLogLen.invoke(self, ((), context)) + + def getLogLenAsync(self, context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Fetch length of log + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + Number of entries in log + """ + return Server._op_getLogLen.invokeAsync(self, ((), context)) + + def getUsers(self, context: dict[str, str] | None = None) -> dict[int, User]: + """ + Fetch all users. This returns all currently connected users on the server. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + dict[int, User] + List of connected users. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getStateAsync` + """ + return Server._op_getUsers.invoke(self, ((), context)) + + def getUsersAsync(self, context: dict[str, str] | None = None) -> Awaitable[dict[int, User]]: + """ + Fetch all users. This returns all currently connected users on the server. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[dict[int, User]] + List of connected users. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getStateAsync` + """ + return Server._op_getUsers.invokeAsync(self, ((), context)) + + def getChannels(self, context: dict[str, str] | None = None) -> dict[int, Channel]: + """ + Fetch all channels. This returns all defined channels on the server. The root channel is always channel 0. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + dict[int, Channel] + List of defined channels. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getChannelStateAsync` + """ + return Server._op_getChannels.invoke(self, ((), context)) + + def getChannelsAsync(self, context: dict[str, str] | None = None) -> Awaitable[dict[int, Channel]]: + """ + Fetch all channels. This returns all defined channels on the server. The root channel is always channel 0. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[dict[int, Channel]] + List of defined channels. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getChannelStateAsync` + """ + return Server._op_getChannels.invokeAsync(self, ((), context)) + + def getCertificateList(self, session: int, context: dict[str, str] | None = None) -> list[bytes]: + """ + Fetch certificate of user. This returns the complete certificate chain of a user. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + list[bytes] + Certificate list of user. + """ + return Server._op_getCertificateList.invoke(self, ((session, ), context)) + + def getCertificateListAsync(self, session: int, context: dict[str, str] | None = None) -> Awaitable[list[bytes]]: + """ + Fetch certificate of user. This returns the complete certificate chain of a user. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[list[bytes]] + Certificate list of user. + """ + return Server._op_getCertificateList.invokeAsync(self, ((session, ), context)) + + def getTree(self, context: dict[str, str] | None = None) -> Tree | None: + """ + Fetch all channels and connected users as a tree. This retrieves an easy-to-use representation of the server + as a tree. This is primarily used for viewing the state of the server on a webpage. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Tree | None + Recursive tree of all channels and connected users. + """ + return Server._op_getTree.invoke(self, ((), context)) + + def getTreeAsync(self, context: dict[str, str] | None = None) -> Awaitable[Tree | None]: + """ + Fetch all channels and connected users as a tree. This retrieves an easy-to-use representation of the server + as a tree. This is primarily used for viewing the state of the server on a webpage. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[Tree | None] + Recursive tree of all channels and connected users. + """ + return Server._op_getTree.invokeAsync(self, ((), context)) + + def getBans(self, context: dict[str, str] | None = None) -> list[Ban]: + """ + Fetch all current IP bans on the server. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + list[Ban] + List of bans. + """ + return Server._op_getBans.invoke(self, ((), context)) + + def getBansAsync(self, context: dict[str, str] | None = None) -> Awaitable[list[Ban]]: + """ + Fetch all current IP bans on the server. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[list[Ban]] + List of bans. + """ + return Server._op_getBans.invokeAsync(self, ((), context)) + + def setBans(self, bans: Sequence[Ban], context: dict[str, str] | None = None) -> None: + """ + 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 :meth:`MumbleServer.ServerPrx.getBansAsync` and then + append to the returned list before calling this method. + + Parameters + ---------- + bans : Sequence[Ban] + List of bans. + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_setBans.invoke(self, ((bans, ), context)) + + def setBansAsync(self, bans: Sequence[Ban], context: dict[str, str] | None = None) -> Awaitable[None]: + """ + 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 :meth:`MumbleServer.ServerPrx.getBansAsync` and then + append to the returned list before calling this method. + + Parameters + ---------- + bans : Sequence[Ban] + List of bans. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_setBans.invokeAsync(self, ((bans, ), context)) + + def kickUser(self, session: int, reason: str, context: dict[str, str] | None = None) -> None: + """ + Kick a user. The user is not banned, and is free to rejoin the server. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + reason : str + Text message to show when user is kicked. + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_kickUser.invoke(self, ((session, reason), context)) + + def kickUserAsync(self, session: int, reason: str, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Kick a user. The user is not banned, and is free to rejoin the server. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + reason : str + Text message to show when user is kicked. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_kickUser.invokeAsync(self, ((session, reason), context)) + + def getState(self, session: int, context: dict[str, str] | None = None) -> User: + """ + Get state of a single connected user. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + User + State of connected user. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.setStateAsync` + :meth:`MumbleServer.ServerPrx.getUsersAsync` + """ + return Server._op_getState.invoke(self, ((session, ), context)) + + def getStateAsync(self, session: int, context: dict[str, str] | None = None) -> Awaitable[User]: + """ + Get state of a single connected user. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[User] + State of connected user. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.setStateAsync` + :meth:`MumbleServer.ServerPrx.getUsersAsync` + """ + return Server._op_getState.invokeAsync(self, ((session, ), context)) + + def setState(self, state: User, context: dict[str, str] | None = None) -> None: + """ + Set user state. You can use this to move, mute and deafen users. + + Parameters + ---------- + state : User + User state to set. + context : dict[str, str] + The request context for the invocation. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getStateAsync` + """ + return Server._op_setState.invoke(self, ((state, ), context)) + + def setStateAsync(self, state: User, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Set user state. You can use this to move, mute and deafen users. + + Parameters + ---------- + state : User + User state to set. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getStateAsync` + """ + return Server._op_setState.invokeAsync(self, ((state, ), context)) + + def sendMessage(self, session: int, text: str, context: dict[str, str] | None = None) -> None: + """ + Send text message to a single user. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + text : str + Message to send. + context : dict[str, str] + The request context for the invocation. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.sendMessageChannelAsync` + """ + return Server._op_sendMessage.invoke(self, ((session, text), context)) + + def sendMessageAsync(self, session: int, text: str, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Send text message to a single user. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + text : str + Message to send. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.sendMessageChannelAsync` + """ + return Server._op_sendMessage.invokeAsync(self, ((session, text), context)) + + def hasPermission(self, session: int, channelid: int, perm: int, context: dict[str, str] | None = None) -> bool: + """ + Check if user is permitted to perform action. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + channelid : int + ID of Channel. See ``Channel.id``. + perm : int + Permission bits to check. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + bool + true if any of the permissions in perm were set for the user. + """ + return Server._op_hasPermission.invoke(self, ((session, channelid, perm), context)) + + def hasPermissionAsync(self, session: int, channelid: int, perm: int, context: dict[str, str] | None = None) -> Awaitable[bool]: + """ + Check if user is permitted to perform action. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + channelid : int + ID of Channel. See ``Channel.id``. + perm : int + Permission bits to check. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[bool] + true if any of the permissions in perm were set for the user. + """ + return Server._op_hasPermission.invokeAsync(self, ((session, channelid, perm), context)) + + def effectivePermissions(self, session: int, channelid: int, context: dict[str, str] | None = None) -> int: + """ + Return users effective permissions + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + channelid : int + ID of Channel. See ``Channel.id``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + bitfield of allowed actions + """ + return Server._op_effectivePermissions.invoke(self, ((session, channelid), context)) + + def effectivePermissionsAsync(self, session: int, channelid: int, context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Return users effective permissions + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + channelid : int + ID of Channel. See ``Channel.id``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + bitfield of allowed actions + """ + return Server._op_effectivePermissions.invokeAsync(self, ((session, channelid), context)) + + def addContextCallback(self, session: int, action: str, text: str, cb: ServerContextCallbackPrx | None, ctx: int, context: dict[str, str] | None = None) -> None: + """ + Add a context callback. This is done per user, and will add a context menu action for the user. + + Parameters + ---------- + session : int + Session of user which should receive context entry. + action : str + Action string, a unique name to associate with the action. + text : str + Name of action shown to user. + cb : ServerContextCallbackPrx | None + Callback interface which will receive notifications. + ctx : int + Context this should be used in. Needs to be one or a combination of :class:`MumbleServer.ContextServer`, :class:`MumbleServer.ContextChannel` and :class:`MumbleServer.ContextUser`. + context : dict[str, str] + The request context for the invocation. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.removeContextCallbackAsync` + """ + return Server._op_addContextCallback.invoke(self, ((session, action, text, cb, ctx), context)) + + def addContextCallbackAsync(self, session: int, action: str, text: str, cb: ServerContextCallbackPrx | None, ctx: int, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Add a context callback. This is done per user, and will add a context menu action for the user. + + Parameters + ---------- + session : int + Session of user which should receive context entry. + action : str + Action string, a unique name to associate with the action. + text : str + Name of action shown to user. + cb : ServerContextCallbackPrx | None + Callback interface which will receive notifications. + ctx : int + Context this should be used in. Needs to be one or a combination of :class:`MumbleServer.ContextServer`, :class:`MumbleServer.ContextChannel` and :class:`MumbleServer.ContextUser`. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.removeContextCallbackAsync` + """ + return Server._op_addContextCallback.invokeAsync(self, ((session, action, text, cb, ctx), context)) + + def removeContextCallback(self, cb: ServerContextCallbackPrx | None, context: dict[str, str] | None = None) -> None: + """ + Remove a callback. + + Parameters + ---------- + cb : ServerContextCallbackPrx | None + Callback interface to be removed. This callback will be removed from all from all users. + context : dict[str, str] + The request context for the invocation. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.addContextCallbackAsync` + """ + return Server._op_removeContextCallback.invoke(self, ((cb, ), context)) + + def removeContextCallbackAsync(self, cb: ServerContextCallbackPrx | None, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Remove a callback. + + Parameters + ---------- + cb : ServerContextCallbackPrx | None + Callback interface to be removed. This callback will be removed from all from all users. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.addContextCallbackAsync` + """ + return Server._op_removeContextCallback.invokeAsync(self, ((cb, ), context)) + + def getChannelState(self, channelid: int, context: dict[str, str] | None = None) -> Channel: + """ + Get state of single channel. + + Parameters + ---------- + channelid : int + ID of Channel. See ``Channel.id``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Channel + State of channel. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.setChannelStateAsync` + :meth:`MumbleServer.ServerPrx.getChannelsAsync` + """ + return Server._op_getChannelState.invoke(self, ((channelid, ), context)) + + def getChannelStateAsync(self, channelid: int, context: dict[str, str] | None = None) -> Awaitable[Channel]: + """ + Get state of single channel. + + Parameters + ---------- + channelid : int + ID of Channel. See ``Channel.id``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[Channel] + State of channel. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.setChannelStateAsync` + :meth:`MumbleServer.ServerPrx.getChannelsAsync` + """ + return Server._op_getChannelState.invokeAsync(self, ((channelid, ), context)) + + def setChannelState(self, state: Channel, context: dict[str, str] | None = None) -> None: + """ + Set state of a single channel. You can use this to move or relink channels. + + Parameters + ---------- + state : Channel + Channel state to set. + context : dict[str, str] + The request context for the invocation. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getChannelStateAsync` + """ + return Server._op_setChannelState.invoke(self, ((state, ), context)) + + def setChannelStateAsync(self, state: Channel, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Set state of a single channel. You can use this to move or relink channels. + + Parameters + ---------- + state : Channel + Channel state to set. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getChannelStateAsync` + """ + return Server._op_setChannelState.invokeAsync(self, ((state, ), context)) + + def removeChannel(self, channelid: int, context: dict[str, str] | None = None) -> None: + """ + Remove a channel and all its subchannels. + + Parameters + ---------- + channelid : int + ID of Channel. See ``Channel.id``. + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_removeChannel.invoke(self, ((channelid, ), context)) + + def removeChannelAsync(self, channelid: int, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Remove a channel and all its subchannels. + + Parameters + ---------- + channelid : int + ID of Channel. See ``Channel.id``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_removeChannel.invokeAsync(self, ((channelid, ), context)) + + def addChannel(self, name: str, parent: int, context: dict[str, str] | None = None) -> int: + """ + Add a new channel. + + Parameters + ---------- + name : str + Name of new channel. + parent : int + Channel ID of parent channel. See ``Channel.id``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + ID of newly created channel. + """ + return Server._op_addChannel.invoke(self, ((name, parent), context)) + + def addChannelAsync(self, name: str, parent: int, context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Add a new channel. + + Parameters + ---------- + name : str + Name of new channel. + parent : int + Channel ID of parent channel. See ``Channel.id``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + ID of newly created channel. + """ + return Server._op_addChannel.invokeAsync(self, ((name, parent), context)) + + def sendMessageChannel(self, channelid: int, tree: bool, text: str, context: dict[str, str] | None = None) -> None: + """ + Send text message to channel or a tree of channels. + + Parameters + ---------- + channelid : int + Channel ID of channel to send to. See ``Channel.id``. + tree : bool + If true, the message will be sent to the channel and all its subchannels. + text : str + Message to send. + context : dict[str, str] + The request context for the invocation. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.sendMessageAsync` + """ + return Server._op_sendMessageChannel.invoke(self, ((channelid, tree, text), context)) + + def sendMessageChannelAsync(self, channelid: int, tree: bool, text: str, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Send text message to channel or a tree of channels. + + Parameters + ---------- + channelid : int + Channel ID of channel to send to. See ``Channel.id``. + tree : bool + If true, the message will be sent to the channel and all its subchannels. + text : str + Message to send. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.sendMessageAsync` + """ + return Server._op_sendMessageChannel.invokeAsync(self, ((channelid, tree, text), context)) + + def getACL(self, channelid: int, context: dict[str, str] | None = None) -> tuple[list[ACL], list[Group], bool]: + """ + Retrieve ACLs and Groups on a channel. + + Parameters + ---------- + channelid : int + Channel ID of channel to fetch from. See ``Channel.id``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + tuple[list[ACL], list[Group], bool] + + A tuple containing: + - list[ACL] List of ACLs on the channel. This will include inherited ACLs. + - list[Group] List of groups on the channel. This will include inherited groups. + - bool Does this channel inherit ACLs from the parent channel? + """ + return Server._op_getACL.invoke(self, ((channelid, ), context)) + + def getACLAsync(self, channelid: int, context: dict[str, str] | None = None) -> Awaitable[tuple[list[ACL], list[Group], bool]]: + """ + Retrieve ACLs and Groups on a channel. + + Parameters + ---------- + channelid : int + Channel ID of channel to fetch from. See ``Channel.id``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[tuple[list[ACL], list[Group], bool]] + + A tuple containing: + - list[ACL] List of ACLs on the channel. This will include inherited ACLs. + - list[Group] List of groups on the channel. This will include inherited groups. + - bool Does this channel inherit ACLs from the parent channel? + """ + return Server._op_getACL.invokeAsync(self, ((channelid, ), context)) + + def setACL(self, channelid: int, acls: Sequence[ACL], groups: Sequence[Group], inherit: bool, context: dict[str, str] | None = None) -> None: + """ + Set ACLs and Groups on a channel. Note that this will replace all existing ACLs and groups on the channel. + + Parameters + ---------- + channelid : int + Channel ID of channel to fetch from. See ``Channel.id``. + acls : Sequence[ACL] + List of ACLs on the channel. + groups : Sequence[Group] + List of groups on the channel. + inherit : bool + Should this channel inherit ACLs from the parent channel? + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_setACL.invoke(self, ((channelid, acls, groups, inherit), context)) + + def setACLAsync(self, channelid: int, acls: Sequence[ACL], groups: Sequence[Group], inherit: bool, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Set ACLs and Groups on a channel. Note that this will replace all existing ACLs and groups on the channel. + + Parameters + ---------- + channelid : int + Channel ID of channel to fetch from. See ``Channel.id``. + acls : Sequence[ACL] + List of ACLs on the channel. + groups : Sequence[Group] + List of groups on the channel. + inherit : bool + Should this channel inherit ACLs from the parent channel? + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_setACL.invokeAsync(self, ((channelid, acls, groups, inherit), context)) + + def addUserToGroup(self, channelid: int, session: int, group: str, context: dict[str, str] | None = None) -> None: + """ + Temporarily add a user to a group on a channel. This state is not saved, and is intended for temporary memberships. + + Parameters + ---------- + channelid : int + Channel ID of channel to add to. See ``Channel.id``. + session : int + Connection ID of user. See ``User.session``. + group : str + Group name to add to. + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_addUserToGroup.invoke(self, ((channelid, session, group), context)) + + def addUserToGroupAsync(self, channelid: int, session: int, group: str, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Temporarily add a user to a group on a channel. This state is not saved, and is intended for temporary memberships. + + Parameters + ---------- + channelid : int + Channel ID of channel to add to. See ``Channel.id``. + session : int + Connection ID of user. See ``User.session``. + group : str + Group name to add to. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_addUserToGroup.invokeAsync(self, ((channelid, session, group), context)) + + def removeUserFromGroup(self, channelid: int, session: int, group: str, context: dict[str, str] | None = None) -> None: + """ + Remove a user from a temporary group membership on a channel. This state is not saved, and is intended for temporary memberships. + + Parameters + ---------- + channelid : int + Channel ID of channel to add to. See ``Channel.id``. + session : int + Connection ID of user. See ``User.session``. + group : str + Group name to remove from. + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_removeUserFromGroup.invoke(self, ((channelid, session, group), context)) + + def removeUserFromGroupAsync(self, channelid: int, session: int, group: str, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Remove a user from a temporary group membership on a channel. This state is not saved, and is intended for temporary memberships. + + Parameters + ---------- + channelid : int + Channel ID of channel to add to. See ``Channel.id``. + session : int + Connection ID of user. See ``User.session``. + group : str + Group name to remove from. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_removeUserFromGroup.invokeAsync(self, ((channelid, session, group), context)) + + def redirectWhisperGroup(self, session: int, source: str, target: str, context: dict[str, str] | None = None) -> None: + """ + 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. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + source : str + Group name to redirect from. + target : str + Group name to redirect to. + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_redirectWhisperGroup.invoke(self, ((session, source, target), context)) + + def redirectWhisperGroupAsync(self, session: int, source: str, target: str, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + 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. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + source : str + Group name to redirect from. + target : str + Group name to redirect to. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_redirectWhisperGroup.invokeAsync(self, ((session, source, target), context)) + + def getUserNames(self, ids: Sequence[int] | Buffer, context: dict[str, str] | None = None) -> dict[int, str]: + """ + Map a list of ``User.userid`` to a matching name. + + Parameters + ---------- + ids : Sequence[int] | Buffer + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + dict[int, str] + Matching list of names, with an empty string representing invalid or unknown ids. + """ + return Server._op_getUserNames.invoke(self, ((ids, ), context)) + + def getUserNamesAsync(self, ids: Sequence[int] | Buffer, context: dict[str, str] | None = None) -> Awaitable[dict[int, str]]: + """ + Map a list of ``User.userid`` to a matching name. + + Parameters + ---------- + ids : Sequence[int] | Buffer + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[dict[int, str]] + Matching list of names, with an empty string representing invalid or unknown ids. + """ + return Server._op_getUserNames.invokeAsync(self, ((ids, ), context)) + + def getUserIds(self, names: Sequence[str], context: dict[str, str] | None = None) -> dict[str, int]: + """ + Map a list of user names to a matching id. + + Parameters + ---------- + names : Sequence[str] + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + dict[str, int] + """ + return Server._op_getUserIds.invoke(self, ((names, ), context)) + + def getUserIdsAsync(self, names: Sequence[str], context: dict[str, str] | None = None) -> Awaitable[dict[str, int]]: + """ + Map a list of user names to a matching id. + + Parameters + ---------- + names : Sequence[str] + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[dict[str, int]] + """ + return Server._op_getUserIds.invokeAsync(self, ((names, ), context)) + + def registerUser(self, info: Mapping[UserInfo, str], context: dict[str, str] | None = None) -> int: + """ + Register a new user. + + Parameters + ---------- + info : Mapping[UserInfo, str] + Information about new user. Must include at least "name". + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + The ID of the user. See ``RegisteredUser.userid``. + """ + return Server._op_registerUser.invoke(self, ((info, ), context)) + + def registerUserAsync(self, info: Mapping[UserInfo, str], context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Register a new user. + + Parameters + ---------- + info : Mapping[UserInfo, str] + Information about new user. Must include at least "name". + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + The ID of the user. See ``RegisteredUser.userid``. + """ + return Server._op_registerUser.invokeAsync(self, ((info, ), context)) + + def unregisterUser(self, userid: int, context: dict[str, str] | None = None) -> None: + """ + Remove a user registration. + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_unregisterUser.invoke(self, ((userid, ), context)) + + def unregisterUserAsync(self, userid: int, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Remove a user registration. + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_unregisterUser.invokeAsync(self, ((userid, ), context)) + + def updateRegistration(self, userid: int, info: Mapping[UserInfo, str], context: dict[str, str] | None = None) -> None: + """ + Update the registration for a user. You can use this to set the email or password of a user, + and can also use it to change the user's name. + + Parameters + ---------- + userid : int + info : Mapping[UserInfo, str] + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_updateRegistration.invoke(self, ((userid, info), context)) + + def updateRegistrationAsync(self, userid: int, info: Mapping[UserInfo, str], context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Update the registration for a user. You can use this to set the email or password of a user, + and can also use it to change the user's name. + + Parameters + ---------- + userid : int + info : Mapping[UserInfo, str] + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_updateRegistration.invokeAsync(self, ((userid, info), context)) + + def getRegistration(self, userid: int, context: dict[str, str] | None = None) -> dict[UserInfo, str]: + """ + Fetch registration for a single user. + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + dict[UserInfo, str] + Registration record. + """ + return Server._op_getRegistration.invoke(self, ((userid, ), context)) + + def getRegistrationAsync(self, userid: int, context: dict[str, str] | None = None) -> Awaitable[dict[UserInfo, str]]: + """ + Fetch registration for a single user. + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[dict[UserInfo, str]] + Registration record. + """ + return Server._op_getRegistration.invokeAsync(self, ((userid, ), context)) + + def getRegisteredUsers(self, filter: str, context: dict[str, str] | None = None) -> dict[int, str]: + """ + Fetch a group of registered users. + + Parameters + ---------- + filter : str + Substring of user name. If blank, will retrieve all registered users. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + dict[int, str] + List of registration records. + """ + return Server._op_getRegisteredUsers.invoke(self, ((filter, ), context)) + + def getRegisteredUsersAsync(self, filter: str, context: dict[str, str] | None = None) -> Awaitable[dict[int, str]]: + """ + Fetch a group of registered users. + + Parameters + ---------- + filter : str + Substring of user name. If blank, will retrieve all registered users. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[dict[int, str]] + List of registration records. + """ + return Server._op_getRegisteredUsers.invokeAsync(self, ((filter, ), context)) + + def verifyPassword(self, name: str, pw: str, context: dict[str, str] | None = None) -> int: + """ + Verify the password of a user. You can use this to verify a user's credentials. + + Parameters + ---------- + name : str + User name. See ``RegisteredUser.name``. + pw : str + User password. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + User ID of registered user (See ``RegisteredUser.userid``), -1 for failed authentication or -2 for unknown usernames. + """ + return Server._op_verifyPassword.invoke(self, ((name, pw), context)) + + def verifyPasswordAsync(self, name: str, pw: str, context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Verify the password of a user. You can use this to verify a user's credentials. + + Parameters + ---------- + name : str + User name. See ``RegisteredUser.name``. + pw : str + User password. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + User ID of registered user (See ``RegisteredUser.userid``), -1 for failed authentication or -2 for unknown usernames. + """ + return Server._op_verifyPassword.invokeAsync(self, ((name, pw), context)) + + def getTexture(self, userid: int, context: dict[str, str] | None = None) -> bytes: + """ + Fetch user texture. Textures are stored as zlib compress()ed 600x60 32-bit BGRA data. + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + bytes + Custom texture associated with user or an empty texture. + """ + return Server._op_getTexture.invoke(self, ((userid, ), context)) + + def getTextureAsync(self, userid: int, context: dict[str, str] | None = None) -> Awaitable[bytes]: + """ + Fetch user texture. Textures are stored as zlib compress()ed 600x60 32-bit BGRA data. + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[bytes] + Custom texture associated with user or an empty texture. + """ + return Server._op_getTexture.invokeAsync(self, ((userid, ), context)) + + def setTexture(self, userid: int, tex: Sequence[int] | bytes | Buffer, context: dict[str, str] | None = None) -> None: + """ + Set a user texture (now called avatar). + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + tex : Sequence[int] | bytes | Buffer + Texture (as a Byte-Array) to set for the user, or an empty texture to remove the existing texture. + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_setTexture.invoke(self, ((userid, tex), context)) + + def setTextureAsync(self, userid: int, tex: Sequence[int] | bytes | Buffer, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Set a user texture (now called avatar). + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + tex : Sequence[int] | bytes | Buffer + Texture (as a Byte-Array) to set for the user, or an empty texture to remove the existing texture. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_setTexture.invokeAsync(self, ((userid, tex), context)) + + def getUptime(self, context: dict[str, str] | None = None) -> int: + """ + Get virtual server uptime. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + Uptime of the virtual server in seconds + """ + return Server._op_getUptime.invoke(self, ((), context)) + + def getUptimeAsync(self, context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Get virtual server uptime. + + Parameters + ---------- + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + Uptime of the virtual server in seconds + """ + return Server._op_getUptime.invokeAsync(self, ((), context)) + + def updateCertificate(self, certificate: str, privateKey: str, passphrase: str, context: dict[str, str] | None = None) -> None: + """ + Update the server's certificate information. + + Reconfigure the running server's TLS socket with the given + certificate and private key. + + The certificate and and private key must be PEM formatted. + + New clients will see the new certificate. + Existing clients will continue to see the certificate the server + was using when they connected to it. + + This method throws InvalidInputDataException if any of the + following errors happen: + - Unable to decode the PEM certificate and/or private key. + - Unable to decrypt the private key with the given passphrase. + - The certificate and/or private key do not contain RSA keys. + - The certificate is not usable with the given private key. + + Parameters + ---------- + certificate : str + privateKey : str + passphrase : str + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_updateCertificate.invoke(self, ((certificate, privateKey, passphrase), context)) + + def updateCertificateAsync(self, certificate: str, privateKey: str, passphrase: str, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Update the server's certificate information. + + Reconfigure the running server's TLS socket with the given + certificate and private key. + + The certificate and and private key must be PEM formatted. + + New clients will see the new certificate. + Existing clients will continue to see the certificate the server + was using when they connected to it. + + This method throws InvalidInputDataException if any of the + following errors happen: + - Unable to decode the PEM certificate and/or private key. + - Unable to decrypt the private key with the given passphrase. + - The certificate and/or private key do not contain RSA keys. + - The certificate is not usable with the given private key. + + Parameters + ---------- + certificate : str + privateKey : str + passphrase : str + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_updateCertificate.invokeAsync(self, ((certificate, privateKey, passphrase), context)) + + def startListening(self, userid: int, channelid: int, context: dict[str, str] | None = None) -> None: + """ + Makes the given user start listening to the given channel. + + Parameters + ---------- + userid : int + The ID of the user + channelid : int + The ID of the channel + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_startListening.invoke(self, ((userid, channelid), context)) + + def startListeningAsync(self, userid: int, channelid: int, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Makes the given user start listening to the given channel. + + Parameters + ---------- + userid : int + The ID of the user + channelid : int + The ID of the channel + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_startListening.invokeAsync(self, ((userid, channelid), context)) + + def stopListening(self, userid: int, channelid: int, context: dict[str, str] | None = None) -> None: + """ + Makes the given user stop listening to the given channel. + + Parameters + ---------- + userid : int + The ID of the user + channelid : int + The ID of the channel + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_stopListening.invoke(self, ((userid, channelid), context)) + + def stopListeningAsync(self, userid: int, channelid: int, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Makes the given user stop listening to the given channel. + + Parameters + ---------- + userid : int + The ID of the user + channelid : int + The ID of the channel + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_stopListening.invokeAsync(self, ((userid, channelid), context)) + + def isListening(self, userid: int, channelid: int, context: dict[str, str] | None = None) -> bool: + """ + Parameters + ---------- + userid : int + The ID of the user + channelid : int + The ID of the channel + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + bool + """ + return Server._op_isListening.invoke(self, ((userid, channelid), context)) + + def isListeningAsync(self, userid: int, channelid: int, context: dict[str, str] | None = None) -> Awaitable[bool]: + """ + Parameters + ---------- + userid : int + The ID of the user + channelid : int + The ID of the channel + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[bool] + """ + return Server._op_isListening.invokeAsync(self, ((userid, channelid), context)) + + def getListeningChannels(self, userid: int, context: dict[str, str] | None = None) -> list[int]: + """ + Parameters + ---------- + userid : int + The ID of the user + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + list[int] + """ + return Server._op_getListeningChannels.invoke(self, ((userid, ), context)) + + def getListeningChannelsAsync(self, userid: int, context: dict[str, str] | None = None) -> Awaitable[list[int]]: + """ + Parameters + ---------- + userid : int + The ID of the user + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[list[int]] + """ + return Server._op_getListeningChannels.invokeAsync(self, ((userid, ), context)) + + def getListeningUsers(self, channelid: int, context: dict[str, str] | None = None) -> list[int]: + """ + Parameters + ---------- + channelid : int + The ID of the channel + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + list[int] + """ + return Server._op_getListeningUsers.invoke(self, ((channelid, ), context)) + + def getListeningUsersAsync(self, channelid: int, context: dict[str, str] | None = None) -> Awaitable[list[int]]: + """ + Parameters + ---------- + channelid : int + The ID of the channel + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[list[int]] + """ + return Server._op_getListeningUsers.invokeAsync(self, ((channelid, ), context)) + + def getListenerVolumeAdjustment(self, channelid: int, userid: int, context: dict[str, str] | None = None) -> float: + """ + Parameters + ---------- + channelid : int + The ID of the channel + userid : int + The ID of the user + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + float + """ + return Server._op_getListenerVolumeAdjustment.invoke(self, ((channelid, userid), context)) + + def getListenerVolumeAdjustmentAsync(self, channelid: int, userid: int, context: dict[str, str] | None = None) -> Awaitable[float]: + """ + Parameters + ---------- + channelid : int + The ID of the channel + userid : int + The ID of the user + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[float] + """ + return Server._op_getListenerVolumeAdjustment.invokeAsync(self, ((channelid, userid), context)) + + def setListenerVolumeAdjustment(self, channelid: int, userid: int, volumeAdjustment: float, context: dict[str, str] | None = None) -> None: + """ + Sets the volume adjustment set for a listener of the given user in the given channel + + Parameters + ---------- + channelid : int + The ID of the channel + userid : int + The ID of the user + volumeAdjustment : float + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_setListenerVolumeAdjustment.invoke(self, ((channelid, userid, volumeAdjustment), context)) + + def setListenerVolumeAdjustmentAsync(self, channelid: int, userid: int, volumeAdjustment: float, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Sets the volume adjustment set for a listener of the given user in the given channel + + Parameters + ---------- + channelid : int + The ID of the channel + userid : int + The ID of the user + volumeAdjustment : float + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_setListenerVolumeAdjustment.invokeAsync(self, ((channelid, userid, volumeAdjustment), context)) + + def sendWelcomeMessage(self, receiverUserIDs: Sequence[int] | Buffer, context: dict[str, str] | None = None) -> None: + """ + Parameters + ---------- + receiverUserIDs : Sequence[int] | Buffer + list of IDs of the users the message shall be sent to + context : dict[str, str] + The request context for the invocation. + """ + return Server._op_sendWelcomeMessage.invoke(self, ((receiverUserIDs, ), context)) + + def sendWelcomeMessageAsync(self, receiverUserIDs: Sequence[int] | Buffer, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Parameters + ---------- + receiverUserIDs : Sequence[int] | Buffer + list of IDs of the users the message shall be sent to + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return Server._op_sendWelcomeMessage.invokeAsync(self, ((receiverUserIDs, ), context)) + + @staticmethod + def checkedCast( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> ServerPrx | None: + return checkedCast(ServerPrx, proxy, facet, context) + + @staticmethod + def checkedCastAsync( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> Awaitable[ServerPrx | None ]: + return checkedCastAsync(ServerPrx, proxy, facet, context) + + @overload + @staticmethod + def uncheckedCast(proxy: ObjectPrx, facet: str | None = None) -> ServerPrx: + ... + + @overload + @staticmethod + def uncheckedCast(proxy: None, facet: str | None = None) -> None: + ... + + @staticmethod + def uncheckedCast(proxy: ObjectPrx | None, facet: str | None = None) -> ServerPrx | None: + return uncheckedCast(ServerPrx, proxy, facet) + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::Server" + +IcePy.defineProxy("::MumbleServer::Server", ServerPrx) + +class Server(Object, ABC): + """ + 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 :class:`MumbleServer.MetaPrx`. + + Notes + ----- + The Slice compiler generated this skeleton class from Slice interface ``::MumbleServer::Server``. + """ + + _ice_ids: Sequence[str] = ("::Ice::Object", "::MumbleServer::Server", ) + _op_isRunning: IcePy.Operation + _op_start: IcePy.Operation + _op_stop: IcePy.Operation + _op_delete: IcePy.Operation + _op_id: IcePy.Operation + _op_addCallback: IcePy.Operation + _op_removeCallback: IcePy.Operation + _op_setAuthenticator: IcePy.Operation + _op_getConf: IcePy.Operation + _op_getAllConf: IcePy.Operation + _op_setConf: IcePy.Operation + _op_setSuperuserPassword: IcePy.Operation + _op_getLog: IcePy.Operation + _op_getLogLen: IcePy.Operation + _op_getUsers: IcePy.Operation + _op_getChannels: IcePy.Operation + _op_getCertificateList: IcePy.Operation + _op_getTree: IcePy.Operation + _op_getBans: IcePy.Operation + _op_setBans: IcePy.Operation + _op_kickUser: IcePy.Operation + _op_getState: IcePy.Operation + _op_setState: IcePy.Operation + _op_sendMessage: IcePy.Operation + _op_hasPermission: IcePy.Operation + _op_effectivePermissions: IcePy.Operation + _op_addContextCallback: IcePy.Operation + _op_removeContextCallback: IcePy.Operation + _op_getChannelState: IcePy.Operation + _op_setChannelState: IcePy.Operation + _op_removeChannel: IcePy.Operation + _op_addChannel: IcePy.Operation + _op_sendMessageChannel: IcePy.Operation + _op_getACL: IcePy.Operation + _op_setACL: IcePy.Operation + _op_addUserToGroup: IcePy.Operation + _op_removeUserFromGroup: IcePy.Operation + _op_redirectWhisperGroup: IcePy.Operation + _op_getUserNames: IcePy.Operation + _op_getUserIds: IcePy.Operation + _op_registerUser: IcePy.Operation + _op_unregisterUser: IcePy.Operation + _op_updateRegistration: IcePy.Operation + _op_getRegistration: IcePy.Operation + _op_getRegisteredUsers: IcePy.Operation + _op_verifyPassword: IcePy.Operation + _op_getTexture: IcePy.Operation + _op_setTexture: IcePy.Operation + _op_getUptime: IcePy.Operation + _op_updateCertificate: IcePy.Operation + _op_startListening: IcePy.Operation + _op_stopListening: IcePy.Operation + _op_isListening: IcePy.Operation + _op_getListeningChannels: IcePy.Operation + _op_getListeningUsers: IcePy.Operation + _op_getListenerVolumeAdjustment: IcePy.Operation + _op_setListenerVolumeAdjustment: IcePy.Operation + _op_sendWelcomeMessage: IcePy.Operation + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::Server" + + @abstractmethod + def isRunning(self, current: Current) -> bool | Awaitable[bool]: + """ + Shows if the server currently running (accepting users). + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + bool | Awaitable[bool] + Run-state of server. + """ + pass + + @abstractmethod + def start(self, current: Current) -> None | Awaitable[None]: + """ + Start server. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def stop(self, current: Current) -> None | Awaitable[None]: + """ + Stop server. + Note: Server will be restarted on application restart unless explicitly disabled + with setConf("boot", false) + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def delete(self, current: Current) -> None | Awaitable[None]: + """ + Delete server and all it's configuration. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def id(self, current: Current) -> int | Awaitable[int]: + """ + Fetch the server id. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + Unique server id. + """ + pass + + @abstractmethod + def addCallback(self, cb: ServerCallbackPrx | None, current: Current) -> None | Awaitable[None]: + """ + Add a callback. The callback will receive notifications about changes to users and channels. + + Parameters + ---------- + cb : ServerCallbackPrx | None + Callback interface which will receive notifications. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.removeCallbackAsync` + """ + pass + + @abstractmethod + def removeCallback(self, cb: ServerCallbackPrx | None, current: Current) -> None | Awaitable[None]: + """ + Remove a callback. + + Parameters + ---------- + cb : ServerCallbackPrx | None + Callback interface to be removed. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.addCallbackAsync` + """ + pass + + @abstractmethod + def setAuthenticator(self, auth: ServerAuthenticatorPrx | None, current: Current) -> None | Awaitable[None]: + """ + Set external authenticator. If set, all authentications from clients are forwarded to this + proxy. + + Parameters + ---------- + auth : ServerAuthenticatorPrx | None + Authenticator object to perform subsequent authentications. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def getConf(self, key: str, current: Current) -> str | Awaitable[str]: + """ + Retrieve configuration item. + + Parameters + ---------- + key : str + Configuration key. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + str | Awaitable[str] + Configuration value. If this is empty, see ``Meta.getDefaultConf`` + """ + pass + + @abstractmethod + def getAllConf(self, current: Current) -> Mapping[str, str] | Awaitable[Mapping[str, str]]: + """ + Retrieve all configuration items. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Mapping[str, str] | Awaitable[Mapping[str, str]] + All configured values. If a value isn't set here, the value from ``Meta.getDefaultConf`` is used. + """ + pass + + @abstractmethod + def setConf(self, key: str, value: str, current: Current) -> None | Awaitable[None]: + """ + Set a configuration item. + + Parameters + ---------- + key : str + Configuration key. + value : str + Configuration value. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def setSuperuserPassword(self, pw: str, current: Current) -> None | Awaitable[None]: + """ + Set superuser password. This is just a convenience for using :meth:`MumbleServer.ServerPrx.updateRegistrationAsync` on user id 0. + + Parameters + ---------- + pw : str + Password. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def getLog(self, first: int, last: int, current: Current) -> Sequence[LogEntry] | Awaitable[Sequence[LogEntry]]: + """ + Fetch log entries. + + Parameters + ---------- + first : int + Lowest numbered entry to fetch. 0 is the most recent item. + last : int + Last entry to fetch. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Sequence[LogEntry] | Awaitable[Sequence[LogEntry]] + List of log entries. + """ + pass + + @abstractmethod + def getLogLen(self, current: Current) -> int | Awaitable[int]: + """ + Fetch length of log + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + Number of entries in log + """ + pass + + @abstractmethod + def getUsers(self, current: Current) -> Mapping[int, User] | Awaitable[Mapping[int, User]]: + """ + Fetch all users. This returns all currently connected users on the server. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Mapping[int, User] | Awaitable[Mapping[int, User]] + List of connected users. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getStateAsync` + """ + pass + + @abstractmethod + def getChannels(self, current: Current) -> Mapping[int, Channel] | Awaitable[Mapping[int, Channel]]: + """ + Fetch all channels. This returns all defined channels on the server. The root channel is always channel 0. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Mapping[int, Channel] | Awaitable[Mapping[int, Channel]] + List of defined channels. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getChannelStateAsync` + """ + pass + + @abstractmethod + def getCertificateList(self, session: int, current: Current) -> Sequence[Sequence[int] | bytes | Buffer] | Awaitable[Sequence[Sequence[int] | bytes | Buffer]]: + """ + Fetch certificate of user. This returns the complete certificate chain of a user. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Sequence[Sequence[int] | bytes | Buffer] | Awaitable[Sequence[Sequence[int] | bytes | Buffer]] + Certificate list of user. + """ + pass + + @abstractmethod + def getTree(self, current: Current) -> Tree | None | Awaitable[Tree | None]: + """ + Fetch all channels and connected users as a tree. This retrieves an easy-to-use representation of the server + as a tree. This is primarily used for viewing the state of the server on a webpage. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Tree | None | Awaitable[Tree | None] + Recursive tree of all channels and connected users. + """ + pass + + @abstractmethod + def getBans(self, current: Current) -> Sequence[Ban] | Awaitable[Sequence[Ban]]: + """ + Fetch all current IP bans on the server. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Sequence[Ban] | Awaitable[Sequence[Ban]] + List of bans. + """ + pass + + @abstractmethod + def setBans(self, bans: list[Ban], current: Current) -> None | Awaitable[None]: + """ + 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 :meth:`MumbleServer.ServerPrx.getBansAsync` and then + append to the returned list before calling this method. + + Parameters + ---------- + bans : list[Ban] + List of bans. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def kickUser(self, session: int, reason: str, current: Current) -> None | Awaitable[None]: + """ + Kick a user. The user is not banned, and is free to rejoin the server. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + reason : str + Text message to show when user is kicked. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def getState(self, session: int, current: Current) -> User | Awaitable[User]: + """ + Get state of a single connected user. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + User | Awaitable[User] + State of connected user. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.setStateAsync` + :meth:`MumbleServer.ServerPrx.getUsersAsync` + """ + pass + + @abstractmethod + def setState(self, state: User, current: Current) -> None | Awaitable[None]: + """ + Set user state. You can use this to move, mute and deafen users. + + Parameters + ---------- + state : User + User state to set. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getStateAsync` + """ + pass + + @abstractmethod + def sendMessage(self, session: int, text: str, current: Current) -> None | Awaitable[None]: + """ + Send text message to a single user. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + text : str + Message to send. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.sendMessageChannelAsync` + """ + pass + + @abstractmethod + def hasPermission(self, session: int, channelid: int, perm: int, current: Current) -> bool | Awaitable[bool]: + """ + Check if user is permitted to perform action. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + channelid : int + ID of Channel. See ``Channel.id``. + perm : int + Permission bits to check. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + bool | Awaitable[bool] + true if any of the permissions in perm were set for the user. + """ + pass + + @abstractmethod + def effectivePermissions(self, session: int, channelid: int, current: Current) -> int | Awaitable[int]: + """ + Return users effective permissions + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + channelid : int + ID of Channel. See ``Channel.id``. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + bitfield of allowed actions + """ + pass + + @abstractmethod + def addContextCallback(self, session: int, action: str, text: str, cb: ServerContextCallbackPrx | None, ctx: int, current: Current) -> None | Awaitable[None]: + """ + Add a context callback. This is done per user, and will add a context menu action for the user. + + Parameters + ---------- + session : int + Session of user which should receive context entry. + action : str + Action string, a unique name to associate with the action. + text : str + Name of action shown to user. + cb : ServerContextCallbackPrx | None + Callback interface which will receive notifications. + ctx : int + Context this should be used in. Needs to be one or a combination of :class:`MumbleServer.ContextServer`, :class:`MumbleServer.ContextChannel` and :class:`MumbleServer.ContextUser`. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.removeContextCallbackAsync` + """ + pass + + @abstractmethod + def removeContextCallback(self, cb: ServerContextCallbackPrx | None, current: Current) -> None | Awaitable[None]: + """ + Remove a callback. + + Parameters + ---------- + cb : ServerContextCallbackPrx | None + Callback interface to be removed. This callback will be removed from all from all users. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.addContextCallbackAsync` + """ + pass + + @abstractmethod + def getChannelState(self, channelid: int, current: Current) -> Channel | Awaitable[Channel]: + """ + Get state of single channel. + + Parameters + ---------- + channelid : int + ID of Channel. See ``Channel.id``. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Channel | Awaitable[Channel] + State of channel. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.setChannelStateAsync` + :meth:`MumbleServer.ServerPrx.getChannelsAsync` + """ + pass + + @abstractmethod + def setChannelState(self, state: Channel, current: Current) -> None | Awaitable[None]: + """ + Set state of a single channel. You can use this to move or relink channels. + + Parameters + ---------- + state : Channel + Channel state to set. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.getChannelStateAsync` + """ + pass + + @abstractmethod + def removeChannel(self, channelid: int, current: Current) -> None | Awaitable[None]: + """ + Remove a channel and all its subchannels. + + Parameters + ---------- + channelid : int + ID of Channel. See ``Channel.id``. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def addChannel(self, name: str, parent: int, current: Current) -> int | Awaitable[int]: + """ + Add a new channel. + + Parameters + ---------- + name : str + Name of new channel. + parent : int + Channel ID of parent channel. See ``Channel.id``. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + ID of newly created channel. + """ + pass + + @abstractmethod + def sendMessageChannel(self, channelid: int, tree: bool, text: str, current: Current) -> None | Awaitable[None]: + """ + Send text message to channel or a tree of channels. + + Parameters + ---------- + channelid : int + Channel ID of channel to send to. See ``Channel.id``. + tree : bool + If true, the message will be sent to the channel and all its subchannels. + text : str + Message to send. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + + See Also + -------- + :meth:`MumbleServer.ServerPrx.sendMessageAsync` + """ + pass + + @abstractmethod + def getACL(self, channelid: int, current: Current) -> tuple[Sequence[ACL], Sequence[Group], bool] | Awaitable[tuple[Sequence[ACL], Sequence[Group], bool]]: + """ + Retrieve ACLs and Groups on a channel. + + Parameters + ---------- + channelid : int + Channel ID of channel to fetch from. See ``Channel.id``. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + tuple[Sequence[ACL], Sequence[Group], bool] | Awaitable[tuple[Sequence[ACL], Sequence[Group], bool]] + + A tuple containing: + - Sequence[ACL] List of ACLs on the channel. This will include inherited ACLs. + - Sequence[Group] List of groups on the channel. This will include inherited groups. + - bool Does this channel inherit ACLs from the parent channel? + """ + pass + + @abstractmethod + def setACL(self, channelid: int, acls: list[ACL], groups: list[Group], inherit: bool, current: Current) -> None | Awaitable[None]: + """ + Set ACLs and Groups on a channel. Note that this will replace all existing ACLs and groups on the channel. + + Parameters + ---------- + channelid : int + Channel ID of channel to fetch from. See ``Channel.id``. + acls : list[ACL] + List of ACLs on the channel. + groups : list[Group] + List of groups on the channel. + inherit : bool + Should this channel inherit ACLs from the parent channel? + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def addUserToGroup(self, channelid: int, session: int, group: str, current: Current) -> None | Awaitable[None]: + """ + Temporarily add a user to a group on a channel. This state is not saved, and is intended for temporary memberships. + + Parameters + ---------- + channelid : int + Channel ID of channel to add to. See ``Channel.id``. + session : int + Connection ID of user. See ``User.session``. + group : str + Group name to add to. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def removeUserFromGroup(self, channelid: int, session: int, group: str, current: Current) -> None | Awaitable[None]: + """ + Remove a user from a temporary group membership on a channel. This state is not saved, and is intended for temporary memberships. + + Parameters + ---------- + channelid : int + Channel ID of channel to add to. See ``Channel.id``. + session : int + Connection ID of user. See ``User.session``. + group : str + Group name to remove from. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def redirectWhisperGroup(self, session: int, source: str, target: str, current: Current) -> None | Awaitable[None]: + """ + 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. + + Parameters + ---------- + session : int + Connection ID of user. See ``User.session``. + source : str + Group name to redirect from. + target : str + Group name to redirect to. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def getUserNames(self, ids: list[int], current: Current) -> Mapping[int, str] | Awaitable[Mapping[int, str]]: + """ + Map a list of ``User.userid`` to a matching name. + + Parameters + ---------- + ids : list[int] + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Mapping[int, str] | Awaitable[Mapping[int, str]] + Matching list of names, with an empty string representing invalid or unknown ids. + """ + pass + + @abstractmethod + def getUserIds(self, names: list[str], current: Current) -> Mapping[str, int] | Awaitable[Mapping[str, int]]: + """ + Map a list of user names to a matching id. + + Parameters + ---------- + names : list[str] + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Mapping[str, int] | Awaitable[Mapping[str, int]] + """ + pass + + @abstractmethod + def registerUser(self, info: dict[UserInfo, str], current: Current) -> int | Awaitable[int]: + """ + Register a new user. + + Parameters + ---------- + info : dict[UserInfo, str] + Information about new user. Must include at least "name". + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + The ID of the user. See ``RegisteredUser.userid``. + """ + pass + + @abstractmethod + def unregisterUser(self, userid: int, current: Current) -> None | Awaitable[None]: + """ + Remove a user registration. + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def updateRegistration(self, userid: int, info: dict[UserInfo, str], current: Current) -> None | Awaitable[None]: + """ + Update the registration for a user. You can use this to set the email or password of a user, + and can also use it to change the user's name. + + Parameters + ---------- + userid : int + info : dict[UserInfo, str] + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def getRegistration(self, userid: int, current: Current) -> Mapping[UserInfo, str] | Awaitable[Mapping[UserInfo, str]]: + """ + Fetch registration for a single user. + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Mapping[UserInfo, str] | Awaitable[Mapping[UserInfo, str]] + Registration record. + """ + pass + + @abstractmethod + def getRegisteredUsers(self, filter: str, current: Current) -> Mapping[int, str] | Awaitable[Mapping[int, str]]: + """ + Fetch a group of registered users. + + Parameters + ---------- + filter : str + Substring of user name. If blank, will retrieve all registered users. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Mapping[int, str] | Awaitable[Mapping[int, str]] + List of registration records. + """ + pass + + @abstractmethod + def verifyPassword(self, name: str, pw: str, current: Current) -> int | Awaitable[int]: + """ + Verify the password of a user. You can use this to verify a user's credentials. + + Parameters + ---------- + name : str + User name. See ``RegisteredUser.name``. + pw : str + User password. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + User ID of registered user (See ``RegisteredUser.userid``), -1 for failed authentication or -2 for unknown usernames. + """ + pass + + @abstractmethod + def getTexture(self, userid: int, current: Current) -> Sequence[int] | bytes | Buffer | Awaitable[Sequence[int] | bytes | Buffer]: + """ + Fetch user texture. Textures are stored as zlib compress()ed 600x60 32-bit BGRA data. + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Sequence[int] | bytes | Buffer | Awaitable[Sequence[int] | bytes | Buffer] + Custom texture associated with user or an empty texture. + """ + pass + + @abstractmethod + def setTexture(self, userid: int, tex: bytes, current: Current) -> None | Awaitable[None]: + """ + Set a user texture (now called avatar). + + Parameters + ---------- + userid : int + ID of registered user. See ``RegisteredUser.userid``. + tex : bytes + Texture (as a Byte-Array) to set for the user, or an empty texture to remove the existing texture. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def getUptime(self, current: Current) -> int | Awaitable[int]: + """ + Get virtual server uptime. + + Parameters + ---------- + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + Uptime of the virtual server in seconds + """ + pass + + @abstractmethod + def updateCertificate(self, certificate: str, privateKey: str, passphrase: str, current: Current) -> None | Awaitable[None]: + """ + Update the server's certificate information. + + Reconfigure the running server's TLS socket with the given + certificate and private key. + + The certificate and and private key must be PEM formatted. + + New clients will see the new certificate. + Existing clients will continue to see the certificate the server + was using when they connected to it. + + This method throws InvalidInputDataException if any of the + following errors happen: + - Unable to decode the PEM certificate and/or private key. + - Unable to decrypt the private key with the given passphrase. + - The certificate and/or private key do not contain RSA keys. + - The certificate is not usable with the given private key. + + Parameters + ---------- + certificate : str + privateKey : str + passphrase : str + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def startListening(self, userid: int, channelid: int, current: Current) -> None | Awaitable[None]: + """ + Makes the given user start listening to the given channel. + + Parameters + ---------- + userid : int + The ID of the user + channelid : int + The ID of the channel + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def stopListening(self, userid: int, channelid: int, current: Current) -> None | Awaitable[None]: + """ + Makes the given user stop listening to the given channel. + + Parameters + ---------- + userid : int + The ID of the user + channelid : int + The ID of the channel + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def isListening(self, userid: int, channelid: int, current: Current) -> bool | Awaitable[bool]: + """ + Parameters + ---------- + userid : int + The ID of the user + channelid : int + The ID of the channel + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + bool | Awaitable[bool] + """ + pass + + @abstractmethod + def getListeningChannels(self, userid: int, current: Current) -> Sequence[int] | Buffer | Awaitable[Sequence[int] | Buffer]: + """ + Parameters + ---------- + userid : int + The ID of the user + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Sequence[int] | Buffer | Awaitable[Sequence[int] | Buffer] + """ + pass + + @abstractmethod + def getListeningUsers(self, channelid: int, current: Current) -> Sequence[int] | Buffer | Awaitable[Sequence[int] | Buffer]: + """ + Parameters + ---------- + channelid : int + The ID of the channel + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Sequence[int] | Buffer | Awaitable[Sequence[int] | Buffer] + """ + pass + + @abstractmethod + def getListenerVolumeAdjustment(self, channelid: int, userid: int, current: Current) -> float | Awaitable[float]: + """ + Parameters + ---------- + channelid : int + The ID of the channel + userid : int + The ID of the user + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + float | Awaitable[float] + """ + pass + + @abstractmethod + def setListenerVolumeAdjustment(self, channelid: int, userid: int, volumeAdjustment: float, current: Current) -> None | Awaitable[None]: + """ + Sets the volume adjustment set for a listener of the given user in the given channel + + Parameters + ---------- + channelid : int + The ID of the channel + userid : int + The ID of the user + volumeAdjustment : float + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def sendWelcomeMessage(self, receiverUserIDs: list[int], current: Current) -> None | Awaitable[None]: + """ + Parameters + ---------- + receiverUserIDs : list[int] + list of IDs of the users the message shall be sent to + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + +Server._op_isRunning = IcePy.Operation( + "isRunning", + "isRunning", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), IcePy._t_bool, False, 0), + (_MumbleServer_InvalidSecretException_t,)) + +Server._op_start = IcePy.Operation( + "start", + "start", + OperationMode.Normal, + None, + (), + (), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_ServerFailureException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_stop = IcePy.Operation( + "stop", + "stop", + OperationMode.Normal, + None, + (), + (), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_delete = IcePy.Operation( + "delete", + "delete", + OperationMode.Normal, + None, + (), + (), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_id = IcePy.Operation( + "id", + "id", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), IcePy._t_int, False, 0), + (_MumbleServer_InvalidSecretException_t,)) + +Server._op_addCallback = IcePy.Operation( + "addCallback", + "addCallback", + OperationMode.Normal, + None, + (), + (((), _MumbleServer_ServerCallbackPrx_t, False, 0),), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidCallbackException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_removeCallback = IcePy.Operation( + "removeCallback", + "removeCallback", + OperationMode.Normal, + None, + (), + (((), _MumbleServer_ServerCallbackPrx_t, False, 0),), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidCallbackException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_setAuthenticator = IcePy.Operation( + "setAuthenticator", + "setAuthenticator", + OperationMode.Normal, + None, + (), + (((), _MumbleServer_ServerAuthenticatorPrx_t, False, 0),), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidCallbackException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_getConf = IcePy.Operation( + "getConf", + "getConf", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_string, False, 0),), + (), + ((), IcePy._t_string, False, 0), + (_MumbleServer_InvalidSecretException_t, _MumbleServer_WriteOnlyException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_getAllConf = IcePy.Operation( + "getAllConf", + "getAllConf", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), _MumbleServer_ConfigMap_t, False, 0), + (_MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_setConf = IcePy.Operation( + "setConf", + "setConf", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0)), + (), + None, + (_MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_setSuperuserPassword = IcePy.Operation( + "setSuperuserPassword", + "setSuperuserPassword", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_string, False, 0),), + (), + None, + (_MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_getLog = IcePy.Operation( + "getLog", + "getLog", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), + (), + ((), _MumbleServer_LogList_t, False, 0), + (_MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_getLogLen = IcePy.Operation( + "getLogLen", + "getLogLen", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), IcePy._t_int, False, 0), + (_MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_getUsers = IcePy.Operation( + "getUsers", + "getUsers", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), _MumbleServer_UserMap_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_getChannels = IcePy.Operation( + "getChannels", + "getChannels", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), _MumbleServer_ChannelMap_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_getCertificateList = IcePy.Operation( + "getCertificateList", + "getCertificateList", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + ((), _MumbleServer_CertificateList_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSessionException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_getTree = IcePy.Operation( + "getTree", + "getTree", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), _MumbleServer_Tree_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_getBans = IcePy.Operation( + "getBans", + "getBans", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), _MumbleServer_BanList_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_setBans = IcePy.Operation( + "setBans", + "setBans", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_BanList_t, False, 0),), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_kickUser = IcePy.Operation( + "kickUser", + "kickUser", + OperationMode.Normal, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSessionException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_getState = IcePy.Operation( + "getState", + "getState", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + ((), _MumbleServer_User_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSessionException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_setState = IcePy.Operation( + "setState", + "setState", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_User_t, False, 0),), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSessionException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_sendMessage = IcePy.Operation( + "sendMessage", + "sendMessage", + OperationMode.Normal, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSessionException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_hasPermission = IcePy.Operation( + "hasPermission", + "hasPermission", + OperationMode.Normal, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), + (), + ((), IcePy._t_bool, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSessionException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_effectivePermissions = IcePy.Operation( + "effectivePermissions", + "effectivePermissions", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), + (), + ((), IcePy._t_int, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSessionException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_addContextCallback = IcePy.Operation( + "addContextCallback", + "addContextCallback", + OperationMode.Normal, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0), ((), _MumbleServer_ServerContextCallbackPrx_t, False, 0), ((), IcePy._t_int, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidCallbackException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_removeContextCallback = IcePy.Operation( + "removeContextCallback", + "removeContextCallback", + OperationMode.Normal, + None, + (), + (((), _MumbleServer_ServerContextCallbackPrx_t, False, 0),), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidCallbackException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_getChannelState = IcePy.Operation( + "getChannelState", + "getChannelState", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + ((), _MumbleServer_Channel_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_setChannelState = IcePy.Operation( + "setChannelState", + "setChannelState", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_Channel_t, False, 0),), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_NestingLimitException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_removeChannel = IcePy.Operation( + "removeChannel", + "removeChannel", + OperationMode.Normal, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_addChannel = IcePy.Operation( + "addChannel", + "addChannel", + OperationMode.Normal, + None, + (), + (((), IcePy._t_string, False, 0), ((), IcePy._t_int, False, 0)), + (), + ((), IcePy._t_int, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_NestingLimitException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_sendMessageChannel = IcePy.Operation( + "sendMessageChannel", + "sendMessageChannel", + OperationMode.Normal, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_bool, False, 0), ((), IcePy._t_string, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_getACL = IcePy.Operation( + "getACL", + "getACL", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (((), _MumbleServer_ACLList_t, False, 0), ((), _MumbleServer_GroupList_t, False, 0), ((), IcePy._t_bool, False, 0)), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_setACL = IcePy.Operation( + "setACL", + "setACL", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), _MumbleServer_ACLList_t, False, 0), ((), _MumbleServer_GroupList_t, False, 0), ((), IcePy._t_bool, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_addUserToGroup = IcePy.Operation( + "addUserToGroup", + "addUserToGroup", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSessionException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_removeUserFromGroup = IcePy.Operation( + "removeUserFromGroup", + "removeUserFromGroup", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidSessionException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_redirectWhisperGroup = IcePy.Operation( + "redirectWhisperGroup", + "redirectWhisperGroup", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSessionException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_getUserNames = IcePy.Operation( + "getUserNames", + "getUserNames", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_IdList_t, False, 0),), + (), + ((), _MumbleServer_NameMap_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_getUserIds = IcePy.Operation( + "getUserIds", + "getUserIds", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_NameList_t, False, 0),), + (), + ((), _MumbleServer_IdMap_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_registerUser = IcePy.Operation( + "registerUser", + "registerUser", + OperationMode.Normal, + None, + (), + (((), _MumbleServer_UserInfoMap_t, False, 0),), + (), + ((), IcePy._t_int, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidUserException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_unregisterUser = IcePy.Operation( + "unregisterUser", + "unregisterUser", + OperationMode.Normal, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidUserException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_updateRegistration = IcePy.Operation( + "updateRegistration", + "updateRegistration", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), _MumbleServer_UserInfoMap_t, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidUserException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_getRegistration = IcePy.Operation( + "getRegistration", + "getRegistration", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + ((), _MumbleServer_UserInfoMap_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidUserException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_getRegisteredUsers = IcePy.Operation( + "getRegisteredUsers", + "getRegisteredUsers", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_string, False, 0),), + (), + ((), _MumbleServer_NameMap_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_verifyPassword = IcePy.Operation( + "verifyPassword", + "verifyPassword", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0)), + (), + ((), IcePy._t_int, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_getTexture = IcePy.Operation( + "getTexture", + "getTexture", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + ((), _MumbleServer_Texture_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidUserException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_setTexture = IcePy.Operation( + "setTexture", + "setTexture", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), _MumbleServer_Texture_t, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidUserException_t, _MumbleServer_InvalidTextureException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_getUptime = IcePy.Operation( + "getUptime", + "getUptime", + OperationMode.Idempotent, + None, + (), + (), + (), + ((), IcePy._t_int, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_updateCertificate = IcePy.Operation( + "updateCertificate", + "updateCertificate", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_InvalidInputDataException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_startListening = IcePy.Operation( + "startListening", + "startListening", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidUserException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_stopListening = IcePy.Operation( + "stopListening", + "stopListening", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidUserException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_isListening = IcePy.Operation( + "isListening", + "isListening", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), + (), + ((), IcePy._t_bool, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidUserException_t, _MumbleServer_InvalidSecretException_t)) + +Server._op_getListeningChannels = IcePy.Operation( + "getListeningChannels", + "getListeningChannels", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + ((), _MumbleServer_IntList_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_InvalidUserException_t)) + +Server._op_getListeningUsers = IcePy.Operation( + "getListeningUsers", + "getListeningUsers", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + ((), _MumbleServer_IntList_t, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_InvalidChannelException_t)) + +Server._op_getListenerVolumeAdjustment = IcePy.Operation( + "getListenerVolumeAdjustment", + "getListenerVolumeAdjustment", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), + (), + ((), IcePy._t_float, False, 0), + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidUserException_t, _MumbleServer_InvalidChannelException_t)) + +Server._op_setListenerVolumeAdjustment = IcePy.Operation( + "setListenerVolumeAdjustment", + "setListenerVolumeAdjustment", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_float, False, 0)), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_InvalidChannelException_t, _MumbleServer_InvalidUserException_t, _MumbleServer_ReadOnlyModeException_t)) + +Server._op_sendWelcomeMessage = IcePy.Operation( + "sendWelcomeMessage", + "sendWelcomeMessage", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_IdList_t, False, 0),), + (), + None, + (_MumbleServer_ServerBootedException_t, _MumbleServer_InvalidSecretException_t, _MumbleServer_InvalidUserException_t)) + +__all__ = ["Server", "ServerPrx", "_MumbleServer_ServerPrx_t"] diff --git a/MumbleServer/ServerAuthenticator.py b/MumbleServer/ServerAuthenticator.py new file mode 100644 index 0000000..4712302 --- /dev/null +++ b/MumbleServer/ServerAuthenticator.py @@ -0,0 +1,531 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from Ice.Object import Object + +from Ice.ObjectPrx import ObjectPrx +from Ice.ObjectPrx import checkedCast +from Ice.ObjectPrx import checkedCastAsync +from Ice.ObjectPrx import uncheckedCast + +from Ice.OperationMode import OperationMode + +from MumbleServer.CertificateList import _MumbleServer_CertificateList_t + +from MumbleServer.GroupNameList import _MumbleServer_GroupNameList_t + +from MumbleServer.ServerAuthenticator_forward import _MumbleServer_ServerAuthenticatorPrx_t + +from MumbleServer.Texture import _MumbleServer_Texture_t + +from MumbleServer.UserInfoMap import _MumbleServer_UserInfoMap_t + +from abc import ABC +from abc import abstractmethod + +from typing import TYPE_CHECKING +from typing import overload + +if TYPE_CHECKING: + from Ice.Current import Current + from MumbleServer.UserInfo import UserInfo + from collections.abc import Awaitable + from collections.abc import Buffer + from collections.abc import Mapping + from collections.abc import Sequence + + +class ServerAuthenticatorPrx(ObjectPrx): + """ + Callback interface for server authentication. You need to supply one of these for ``Server.setAuthenticator``. + If an added callback ever throws an exception or goes away, it will be automatically removed. + Please note that unlike :class:`MumbleServer.ServerCallbackPrx` and :class:`MumbleServer.ServerContextCallbackPrx`, these methods are called + synchronously. If the response lags, the entire server will lag. + Also note that, as the method calls are synchronous, making a call to :class:`MumbleServer.ServerPrx` or :class:`MumbleServer.MetaPrx` will + deadlock the server. + + Notes + ----- + The Slice compiler generated this proxy class from Slice interface ``::MumbleServer::ServerAuthenticator``. + """ + + def authenticate(self, name: str, pw: str, certificates: Sequence[Sequence[int] | bytes | Buffer], certhash: str, certstrong: bool, context: dict[str, str] | None = None) -> tuple[int, str, list[str]]: + """ + Called to authenticate a user. If you do not know the username in question, always return -2 from this + method to fall through to normal database authentication. + Note that if authentication succeeds, the server will create a record of the user in it's database, reserving + the username and id so it cannot be used for normal database authentication. + The data in the certificate (name, email addresses etc), as well as the list of signing certificates, + should only be trusted if certstrong is true. + + Internally, the server treats usernames as case-insensitive. It is recommended + that authenticators do the same. the server checks if a username is in use when + a user connects. If the connecting user is registered, the other username is + kicked. If the connecting user is not registered, the connecting user is not + allowed to join the server. + + Parameters + ---------- + name : str + Username to authenticate. + pw : str + Password to authenticate with. + certificates : Sequence[Sequence[int] | bytes | Buffer] + List of der encoded certificates the user connected with. + certhash : str + Hash of user certificate, as used by the server internally when matching. + certstrong : bool + True if certificate was valid and signed by a trusted CA. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + tuple[int, str, list[str]] + + A tuple containing: + - int UserID of authenticated user, -1 for authentication failures, -2 for unknown user (fallthrough), + -3 for authentication failures where the data could (temporarily) not be verified. + - str Set this to change the username from the supplied one. + - list[str] List of groups on the root channel that the user will be added to for the duration of the connection. + """ + return ServerAuthenticator._op_authenticate.invoke(self, ((name, pw, certificates, certhash, certstrong), context)) + + def authenticateAsync(self, name: str, pw: str, certificates: Sequence[Sequence[int] | bytes | Buffer], certhash: str, certstrong: bool, context: dict[str, str] | None = None) -> Awaitable[tuple[int, str, list[str]]]: + """ + Called to authenticate a user. If you do not know the username in question, always return -2 from this + method to fall through to normal database authentication. + Note that if authentication succeeds, the server will create a record of the user in it's database, reserving + the username and id so it cannot be used for normal database authentication. + The data in the certificate (name, email addresses etc), as well as the list of signing certificates, + should only be trusted if certstrong is true. + + Internally, the server treats usernames as case-insensitive. It is recommended + that authenticators do the same. the server checks if a username is in use when + a user connects. If the connecting user is registered, the other username is + kicked. If the connecting user is not registered, the connecting user is not + allowed to join the server. + + Parameters + ---------- + name : str + Username to authenticate. + pw : str + Password to authenticate with. + certificates : Sequence[Sequence[int] | bytes | Buffer] + List of der encoded certificates the user connected with. + certhash : str + Hash of user certificate, as used by the server internally when matching. + certstrong : bool + True if certificate was valid and signed by a trusted CA. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[tuple[int, str, list[str]]] + + A tuple containing: + - int UserID of authenticated user, -1 for authentication failures, -2 for unknown user (fallthrough), + -3 for authentication failures where the data could (temporarily) not be verified. + - str Set this to change the username from the supplied one. + - list[str] List of groups on the root channel that the user will be added to for the duration of the connection. + """ + return ServerAuthenticator._op_authenticate.invokeAsync(self, ((name, pw, certificates, certhash, certstrong), context)) + + def getInfo(self, id: int, context: dict[str, str] | None = None) -> tuple[bool, dict[UserInfo, str]]: + """ + Fetch information about a user. This is used to retrieve information like email address, keyhash etc. If you + want the server to take care of this information itself, simply return false to fall through. + + Parameters + ---------- + id : int + User id. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + tuple[bool, dict[UserInfo, str]] + + A tuple containing: + - bool true if information is present, false to fall through. + - dict[UserInfo, str] Information about user. This needs to include at least "name". + """ + return ServerAuthenticator._op_getInfo.invoke(self, ((id, ), context)) + + def getInfoAsync(self, id: int, context: dict[str, str] | None = None) -> Awaitable[tuple[bool, dict[UserInfo, str]]]: + """ + Fetch information about a user. This is used to retrieve information like email address, keyhash etc. If you + want the server to take care of this information itself, simply return false to fall through. + + Parameters + ---------- + id : int + User id. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[tuple[bool, dict[UserInfo, str]]] + + A tuple containing: + - bool true if information is present, false to fall through. + - dict[UserInfo, str] Information about user. This needs to include at least "name". + """ + return ServerAuthenticator._op_getInfo.invokeAsync(self, ((id, ), context)) + + def nameToId(self, name: str, context: dict[str, str] | None = None) -> int: + """ + Map a name to a user id. + + Parameters + ---------- + name : str + Username to map. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + User id or -2 for unknown name. + """ + return ServerAuthenticator._op_nameToId.invoke(self, ((name, ), context)) + + def nameToIdAsync(self, name: str, context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Map a name to a user id. + + Parameters + ---------- + name : str + Username to map. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + User id or -2 for unknown name. + """ + return ServerAuthenticator._op_nameToId.invokeAsync(self, ((name, ), context)) + + def idToName(self, id: int, context: dict[str, str] | None = None) -> str: + """ + Map a user id to a username. + + Parameters + ---------- + id : int + User id to map. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + str + Name of user or empty string for unknown id. + """ + return ServerAuthenticator._op_idToName.invoke(self, ((id, ), context)) + + def idToNameAsync(self, id: int, context: dict[str, str] | None = None) -> Awaitable[str]: + """ + Map a user id to a username. + + Parameters + ---------- + id : int + User id to map. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[str] + Name of user or empty string for unknown id. + """ + return ServerAuthenticator._op_idToName.invokeAsync(self, ((id, ), context)) + + def idToTexture(self, id: int, context: dict[str, str] | None = None) -> bytes: + """ + Map a user to a custom Texture. + + Parameters + ---------- + id : int + User id to map. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + bytes + User texture or an empty texture for unknown users or users without textures. + """ + return ServerAuthenticator._op_idToTexture.invoke(self, ((id, ), context)) + + def idToTextureAsync(self, id: int, context: dict[str, str] | None = None) -> Awaitable[bytes]: + """ + Map a user to a custom Texture. + + Parameters + ---------- + id : int + User id to map. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[bytes] + User texture or an empty texture for unknown users or users without textures. + """ + return ServerAuthenticator._op_idToTexture.invokeAsync(self, ((id, ), context)) + + @staticmethod + def checkedCast( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> ServerAuthenticatorPrx | None: + return checkedCast(ServerAuthenticatorPrx, proxy, facet, context) + + @staticmethod + def checkedCastAsync( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> Awaitable[ServerAuthenticatorPrx | None ]: + return checkedCastAsync(ServerAuthenticatorPrx, proxy, facet, context) + + @overload + @staticmethod + def uncheckedCast(proxy: ObjectPrx, facet: str | None = None) -> ServerAuthenticatorPrx: + ... + + @overload + @staticmethod + def uncheckedCast(proxy: None, facet: str | None = None) -> None: + ... + + @staticmethod + def uncheckedCast(proxy: ObjectPrx | None, facet: str | None = None) -> ServerAuthenticatorPrx | None: + return uncheckedCast(ServerAuthenticatorPrx, proxy, facet) + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::ServerAuthenticator" + +IcePy.defineProxy("::MumbleServer::ServerAuthenticator", ServerAuthenticatorPrx) + +class ServerAuthenticator(Object, ABC): + """ + Callback interface for server authentication. You need to supply one of these for ``Server.setAuthenticator``. + If an added callback ever throws an exception or goes away, it will be automatically removed. + Please note that unlike :class:`MumbleServer.ServerCallbackPrx` and :class:`MumbleServer.ServerContextCallbackPrx`, these methods are called + synchronously. If the response lags, the entire server will lag. + Also note that, as the method calls are synchronous, making a call to :class:`MumbleServer.ServerPrx` or :class:`MumbleServer.MetaPrx` will + deadlock the server. + + Notes + ----- + The Slice compiler generated this skeleton class from Slice interface ``::MumbleServer::ServerAuthenticator``. + """ + + _ice_ids: Sequence[str] = ("::Ice::Object", "::MumbleServer::ServerAuthenticator", ) + _op_authenticate: IcePy.Operation + _op_getInfo: IcePy.Operation + _op_nameToId: IcePy.Operation + _op_idToName: IcePy.Operation + _op_idToTexture: IcePy.Operation + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::ServerAuthenticator" + + @abstractmethod + def authenticate(self, name: str, pw: str, certificates: list[bytes], certhash: str, certstrong: bool, current: Current) -> tuple[int, str, Sequence[str]] | Awaitable[tuple[int, str, Sequence[str]]]: + """ + Called to authenticate a user. If you do not know the username in question, always return -2 from this + method to fall through to normal database authentication. + Note that if authentication succeeds, the server will create a record of the user in it's database, reserving + the username and id so it cannot be used for normal database authentication. + The data in the certificate (name, email addresses etc), as well as the list of signing certificates, + should only be trusted if certstrong is true. + + Internally, the server treats usernames as case-insensitive. It is recommended + that authenticators do the same. the server checks if a username is in use when + a user connects. If the connecting user is registered, the other username is + kicked. If the connecting user is not registered, the connecting user is not + allowed to join the server. + + Parameters + ---------- + name : str + Username to authenticate. + pw : str + Password to authenticate with. + certificates : list[bytes] + List of der encoded certificates the user connected with. + certhash : str + Hash of user certificate, as used by the server internally when matching. + certstrong : bool + True if certificate was valid and signed by a trusted CA. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + tuple[int, str, Sequence[str]] | Awaitable[tuple[int, str, Sequence[str]]] + + A tuple containing: + - int UserID of authenticated user, -1 for authentication failures, -2 for unknown user (fallthrough), + -3 for authentication failures where the data could (temporarily) not be verified. + - str Set this to change the username from the supplied one. + - Sequence[str] List of groups on the root channel that the user will be added to for the duration of the connection. + """ + pass + + @abstractmethod + def getInfo(self, id: int, current: Current) -> tuple[bool, Mapping[UserInfo, str]] | Awaitable[tuple[bool, Mapping[UserInfo, str]]]: + """ + Fetch information about a user. This is used to retrieve information like email address, keyhash etc. If you + want the server to take care of this information itself, simply return false to fall through. + + Parameters + ---------- + id : int + User id. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + tuple[bool, Mapping[UserInfo, str]] | Awaitable[tuple[bool, Mapping[UserInfo, str]]] + + A tuple containing: + - bool true if information is present, false to fall through. + - Mapping[UserInfo, str] Information about user. This needs to include at least "name". + """ + pass + + @abstractmethod + def nameToId(self, name: str, current: Current) -> int | Awaitable[int]: + """ + Map a name to a user id. + + Parameters + ---------- + name : str + Username to map. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + User id or -2 for unknown name. + """ + pass + + @abstractmethod + def idToName(self, id: int, current: Current) -> str | Awaitable[str]: + """ + Map a user id to a username. + + Parameters + ---------- + id : int + User id to map. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + str | Awaitable[str] + Name of user or empty string for unknown id. + """ + pass + + @abstractmethod + def idToTexture(self, id: int, current: Current) -> Sequence[int] | bytes | Buffer | Awaitable[Sequence[int] | bytes | Buffer]: + """ + Map a user to a custom Texture. + + Parameters + ---------- + id : int + User id to map. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Sequence[int] | bytes | Buffer | Awaitable[Sequence[int] | bytes | Buffer] + User texture or an empty texture for unknown users or users without textures. + """ + pass + +ServerAuthenticator._op_authenticate = IcePy.Operation( + "authenticate", + "authenticate", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0), ((), _MumbleServer_CertificateList_t, False, 0), ((), IcePy._t_string, False, 0), ((), IcePy._t_bool, False, 0)), + (((), IcePy._t_string, False, 0), ((), _MumbleServer_GroupNameList_t, False, 0)), + ((), IcePy._t_int, False, 0), + ()) + +ServerAuthenticator._op_getInfo = IcePy.Operation( + "getInfo", + "getInfo", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (((), _MumbleServer_UserInfoMap_t, False, 0),), + ((), IcePy._t_bool, False, 0), + ()) + +ServerAuthenticator._op_nameToId = IcePy.Operation( + "nameToId", + "nameToId", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_string, False, 0),), + (), + ((), IcePy._t_int, False, 0), + ()) + +ServerAuthenticator._op_idToName = IcePy.Operation( + "idToName", + "idToName", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + ((), IcePy._t_string, False, 0), + ()) + +ServerAuthenticator._op_idToTexture = IcePy.Operation( + "idToTexture", + "idToTexture", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + ((), _MumbleServer_Texture_t, False, 0), + ()) + +__all__ = ["ServerAuthenticator", "ServerAuthenticatorPrx", "_MumbleServer_ServerAuthenticatorPrx_t"] diff --git a/MumbleServer/ServerAuthenticator_forward.py b/MumbleServer/ServerAuthenticator_forward.py new file mode 100644 index 0000000..15761ad --- /dev/null +++ b/MumbleServer/ServerAuthenticator_forward.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_ServerAuthenticatorPrx_t = IcePy.declareProxy("::MumbleServer::ServerAuthenticator") + +__all__ = ["_MumbleServer_ServerAuthenticatorPrx_t"] \ No newline at end of file diff --git a/MumbleServer/ServerBootedException.py b/MumbleServer/ServerBootedException.py new file mode 100644 index 0000000..a550cfd --- /dev/null +++ b/MumbleServer/ServerBootedException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class ServerBootedException(ServerException): + """ + 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. + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::ServerBootedException``. + """ + + _ice_id = "::MumbleServer::ServerBootedException" + +_MumbleServer_ServerBootedException_t = IcePy.defineException( + "::MumbleServer::ServerBootedException", + ServerBootedException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(ServerBootedException, '_ice_type', _MumbleServer_ServerBootedException_t) + +__all__ = ["ServerBootedException", "_MumbleServer_ServerBootedException_t"] diff --git a/MumbleServer/ServerCallback.py b/MumbleServer/ServerCallback.py new file mode 100644 index 0000000..535faea --- /dev/null +++ b/MumbleServer/ServerCallback.py @@ -0,0 +1,565 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from Ice.Object import Object + +from Ice.ObjectPrx import ObjectPrx +from Ice.ObjectPrx import checkedCast +from Ice.ObjectPrx import checkedCastAsync +from Ice.ObjectPrx import uncheckedCast + +from Ice.OperationMode import OperationMode + +from MumbleServer.Channel import _MumbleServer_Channel_t + +from MumbleServer.ServerCallback_forward import _MumbleServer_ServerCallbackPrx_t + +from MumbleServer.TextMessage import _MumbleServer_TextMessage_t + +from MumbleServer.User import _MumbleServer_User_t + +from abc import ABC +from abc import abstractmethod + +from typing import TYPE_CHECKING +from typing import overload + +if TYPE_CHECKING: + from Ice.Current import Current + from MumbleServer.Channel import Channel + from MumbleServer.TextMessage import TextMessage + from MumbleServer.User import User + from collections.abc import Awaitable + from collections.abc import Sequence + + +class ServerCallbackPrx(ObjectPrx): + """ + Callback interface for servers. You can supply an implementation of this to receive notification + messages from the server. + If an added callback ever throws an exception or goes away, it will be automatically removed. + Please note that all callbacks are done asynchronously; the server 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``. + + Notes + ----- + The Slice compiler generated this proxy class from Slice interface ``::MumbleServer::ServerCallback``. + + See Also + -------- + :class:`MumbleServer.MetaCallbackPrx` + ``Server.addCallback`` + """ + + def userConnected(self, state: User, context: dict[str, str] | None = None) -> None: + """ + Called when a user connects to the server. + + Parameters + ---------- + state : User + State of connected user. + context : dict[str, str] + The request context for the invocation. + """ + return ServerCallback._op_userConnected.invoke(self, ((state, ), context)) + + def userConnectedAsync(self, state: User, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Called when a user connects to the server. + + Parameters + ---------- + state : User + State of connected user. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return ServerCallback._op_userConnected.invokeAsync(self, ((state, ), context)) + + def userDisconnected(self, state: User, context: dict[str, str] | None = None) -> None: + """ + Called when a user disconnects from the server. The user has already been removed, so you can no longer use methods like ``Server.getState`` + to retrieve the user's state. + + Parameters + ---------- + state : User + State of disconnected user. + context : dict[str, str] + The request context for the invocation. + """ + return ServerCallback._op_userDisconnected.invoke(self, ((state, ), context)) + + def userDisconnectedAsync(self, state: User, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Called when a user disconnects from the server. The user has already been removed, so you can no longer use methods like ``Server.getState`` + to retrieve the user's state. + + Parameters + ---------- + state : User + State of disconnected user. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return ServerCallback._op_userDisconnected.invokeAsync(self, ((state, ), context)) + + def userStateChanged(self, state: User, context: dict[str, str] | None = None) -> None: + """ + Called when a user state changes. This is called if the user moves, is renamed, is muted, deafened etc. + + Parameters + ---------- + state : User + New state of user. + context : dict[str, str] + The request context for the invocation. + """ + return ServerCallback._op_userStateChanged.invoke(self, ((state, ), context)) + + def userStateChangedAsync(self, state: User, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Called when a user state changes. This is called if the user moves, is renamed, is muted, deafened etc. + + Parameters + ---------- + state : User + New state of user. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return ServerCallback._op_userStateChanged.invokeAsync(self, ((state, ), context)) + + def userTextMessage(self, state: User, message: TextMessage, context: dict[str, str] | None = None) -> None: + """ + Called when user writes a text message + + Parameters + ---------- + state : User + the User sending the message + message : TextMessage + the TextMessage the user has sent + context : dict[str, str] + The request context for the invocation. + """ + return ServerCallback._op_userTextMessage.invoke(self, ((state, message), context)) + + def userTextMessageAsync(self, state: User, message: TextMessage, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Called when user writes a text message + + Parameters + ---------- + state : User + the User sending the message + message : TextMessage + the TextMessage the user has sent + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return ServerCallback._op_userTextMessage.invokeAsync(self, ((state, message), context)) + + def channelCreated(self, state: Channel, context: dict[str, str] | None = None) -> None: + """ + Called when a new channel is created. + + Parameters + ---------- + state : Channel + State of new channel. + context : dict[str, str] + The request context for the invocation. + """ + return ServerCallback._op_channelCreated.invoke(self, ((state, ), context)) + + def channelCreatedAsync(self, state: Channel, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Called when a new channel is created. + + Parameters + ---------- + state : Channel + State of new channel. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return ServerCallback._op_channelCreated.invokeAsync(self, ((state, ), context)) + + def channelRemoved(self, state: Channel, context: dict[str, str] | None = None) -> None: + """ + Called when a channel is removed. The channel has already been removed, you can no longer use methods like ``Server.getChannelState`` + + Parameters + ---------- + state : Channel + State of removed channel. + context : dict[str, str] + The request context for the invocation. + """ + return ServerCallback._op_channelRemoved.invoke(self, ((state, ), context)) + + def channelRemovedAsync(self, state: Channel, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Called when a channel is removed. The channel has already been removed, you can no longer use methods like ``Server.getChannelState`` + + Parameters + ---------- + state : Channel + State of removed channel. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return ServerCallback._op_channelRemoved.invokeAsync(self, ((state, ), context)) + + def channelStateChanged(self, state: Channel, context: dict[str, str] | None = None) -> None: + """ + Called when a new channel state changes. This is called if the channel is moved, renamed or if new links are added. + + Parameters + ---------- + state : Channel + New state of channel. + context : dict[str, str] + The request context for the invocation. + """ + return ServerCallback._op_channelStateChanged.invoke(self, ((state, ), context)) + + def channelStateChangedAsync(self, state: Channel, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Called when a new channel state changes. This is called if the channel is moved, renamed or if new links are added. + + Parameters + ---------- + state : Channel + New state of channel. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return ServerCallback._op_channelStateChanged.invokeAsync(self, ((state, ), context)) + + @staticmethod + def checkedCast( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> ServerCallbackPrx | None: + return checkedCast(ServerCallbackPrx, proxy, facet, context) + + @staticmethod + def checkedCastAsync( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> Awaitable[ServerCallbackPrx | None ]: + return checkedCastAsync(ServerCallbackPrx, proxy, facet, context) + + @overload + @staticmethod + def uncheckedCast(proxy: ObjectPrx, facet: str | None = None) -> ServerCallbackPrx: + ... + + @overload + @staticmethod + def uncheckedCast(proxy: None, facet: str | None = None) -> None: + ... + + @staticmethod + def uncheckedCast(proxy: ObjectPrx | None, facet: str | None = None) -> ServerCallbackPrx | None: + return uncheckedCast(ServerCallbackPrx, proxy, facet) + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::ServerCallback" + +IcePy.defineProxy("::MumbleServer::ServerCallback", ServerCallbackPrx) + +class ServerCallback(Object, ABC): + """ + Callback interface for servers. You can supply an implementation of this to receive notification + messages from the server. + If an added callback ever throws an exception or goes away, it will be automatically removed. + Please note that all callbacks are done asynchronously; the server 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``. + + Notes + ----- + The Slice compiler generated this skeleton class from Slice interface ``::MumbleServer::ServerCallback``. + + See Also + -------- + :class:`MumbleServer.MetaCallbackPrx` + ``Server.addCallback`` + """ + + _ice_ids: Sequence[str] = ("::Ice::Object", "::MumbleServer::ServerCallback", ) + _op_userConnected: IcePy.Operation + _op_userDisconnected: IcePy.Operation + _op_userStateChanged: IcePy.Operation + _op_userTextMessage: IcePy.Operation + _op_channelCreated: IcePy.Operation + _op_channelRemoved: IcePy.Operation + _op_channelStateChanged: IcePy.Operation + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::ServerCallback" + + @abstractmethod + def userConnected(self, state: User, current: Current) -> None | Awaitable[None]: + """ + Called when a user connects to the server. + + Parameters + ---------- + state : User + State of connected user. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def userDisconnected(self, state: User, current: Current) -> None | Awaitable[None]: + """ + Called when a user disconnects from the server. The user has already been removed, so you can no longer use methods like ``Server.getState`` + to retrieve the user's state. + + Parameters + ---------- + state : User + State of disconnected user. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def userStateChanged(self, state: User, current: Current) -> None | Awaitable[None]: + """ + Called when a user state changes. This is called if the user moves, is renamed, is muted, deafened etc. + + Parameters + ---------- + state : User + New state of user. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def userTextMessage(self, state: User, message: TextMessage, current: Current) -> None | Awaitable[None]: + """ + Called when user writes a text message + + Parameters + ---------- + state : User + the User sending the message + message : TextMessage + the TextMessage the user has sent + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def channelCreated(self, state: Channel, current: Current) -> None | Awaitable[None]: + """ + Called when a new channel is created. + + Parameters + ---------- + state : Channel + State of new channel. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def channelRemoved(self, state: Channel, current: Current) -> None | Awaitable[None]: + """ + Called when a channel is removed. The channel has already been removed, you can no longer use methods like ``Server.getChannelState`` + + Parameters + ---------- + state : Channel + State of removed channel. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + + @abstractmethod + def channelStateChanged(self, state: Channel, current: Current) -> None | Awaitable[None]: + """ + Called when a new channel state changes. This is called if the channel is moved, renamed or if new links are added. + + Parameters + ---------- + state : Channel + New state of channel. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + +ServerCallback._op_userConnected = IcePy.Operation( + "userConnected", + "userConnected", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_User_t, False, 0),), + (), + None, + ()) + +ServerCallback._op_userDisconnected = IcePy.Operation( + "userDisconnected", + "userDisconnected", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_User_t, False, 0),), + (), + None, + ()) + +ServerCallback._op_userStateChanged = IcePy.Operation( + "userStateChanged", + "userStateChanged", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_User_t, False, 0),), + (), + None, + ()) + +ServerCallback._op_userTextMessage = IcePy.Operation( + "userTextMessage", + "userTextMessage", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_User_t, False, 0), ((), _MumbleServer_TextMessage_t, False, 0)), + (), + None, + ()) + +ServerCallback._op_channelCreated = IcePy.Operation( + "channelCreated", + "channelCreated", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_Channel_t, False, 0),), + (), + None, + ()) + +ServerCallback._op_channelRemoved = IcePy.Operation( + "channelRemoved", + "channelRemoved", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_Channel_t, False, 0),), + (), + None, + ()) + +ServerCallback._op_channelStateChanged = IcePy.Operation( + "channelStateChanged", + "channelStateChanged", + OperationMode.Idempotent, + None, + (), + (((), _MumbleServer_Channel_t, False, 0),), + (), + None, + ()) + +__all__ = ["ServerCallback", "ServerCallbackPrx", "_MumbleServer_ServerCallbackPrx_t"] diff --git a/MumbleServer/ServerCallback_forward.py b/MumbleServer/ServerCallback_forward.py new file mode 100644 index 0000000..26d4f49 --- /dev/null +++ b/MumbleServer/ServerCallback_forward.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_ServerCallbackPrx_t = IcePy.declareProxy("::MumbleServer::ServerCallback") + +__all__ = ["_MumbleServer_ServerCallbackPrx_t"] \ No newline at end of file diff --git a/MumbleServer/ServerContextCallback.py b/MumbleServer/ServerContextCallback.py new file mode 100644 index 0000000..0dc2ec0 --- /dev/null +++ b/MumbleServer/ServerContextCallback.py @@ -0,0 +1,180 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from Ice.Object import Object + +from Ice.ObjectPrx import ObjectPrx +from Ice.ObjectPrx import checkedCast +from Ice.ObjectPrx import checkedCastAsync +from Ice.ObjectPrx import uncheckedCast + +from Ice.OperationMode import OperationMode + +from MumbleServer.ServerContextCallback_forward import _MumbleServer_ServerContextCallbackPrx_t + +from MumbleServer.User import _MumbleServer_User_t + +from abc import ABC +from abc import abstractmethod + +from typing import TYPE_CHECKING +from typing import overload + +if TYPE_CHECKING: + from Ice.Current import Current + from MumbleServer.User import User + from collections.abc import Awaitable + from collections.abc import Sequence + + +class ServerContextCallbackPrx(ObjectPrx): + """ + Callback interface for context actions. You need to supply one of these for ``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; the server does not wait for the callback to + complete before continuing processing. + + Notes + ----- + The Slice compiler generated this proxy class from Slice interface ``::MumbleServer::ServerContextCallback``. + """ + + def contextAction(self, action: str, usr: User, session: int, channelid: int, context: dict[str, str] | None = None) -> None: + """ + Called when a context action is performed. + + Parameters + ---------- + action : str + Action to be performed. + usr : User + User which initiated the action. + session : int + If nonzero, session of target user. + channelid : int + If not -1, id of target channel. + context : dict[str, str] + The request context for the invocation. + """ + return ServerContextCallback._op_contextAction.invoke(self, ((action, usr, session, channelid), context)) + + def contextActionAsync(self, action: str, usr: User, session: int, channelid: int, context: dict[str, str] | None = None) -> Awaitable[None]: + """ + Called when a context action is performed. + + Parameters + ---------- + action : str + Action to be performed. + usr : User + User which initiated the action. + session : int + If nonzero, session of target user. + channelid : int + If not -1, id of target channel. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[None] + An awaitable that is completed when the invocation completes. + """ + return ServerContextCallback._op_contextAction.invokeAsync(self, ((action, usr, session, channelid), context)) + + @staticmethod + def checkedCast( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> ServerContextCallbackPrx | None: + return checkedCast(ServerContextCallbackPrx, proxy, facet, context) + + @staticmethod + def checkedCastAsync( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> Awaitable[ServerContextCallbackPrx | None ]: + return checkedCastAsync(ServerContextCallbackPrx, proxy, facet, context) + + @overload + @staticmethod + def uncheckedCast(proxy: ObjectPrx, facet: str | None = None) -> ServerContextCallbackPrx: + ... + + @overload + @staticmethod + def uncheckedCast(proxy: None, facet: str | None = None) -> None: + ... + + @staticmethod + def uncheckedCast(proxy: ObjectPrx | None, facet: str | None = None) -> ServerContextCallbackPrx | None: + return uncheckedCast(ServerContextCallbackPrx, proxy, facet) + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::ServerContextCallback" + +IcePy.defineProxy("::MumbleServer::ServerContextCallback", ServerContextCallbackPrx) + +class ServerContextCallback(Object, ABC): + """ + Callback interface for context actions. You need to supply one of these for ``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; the server does not wait for the callback to + complete before continuing processing. + + Notes + ----- + The Slice compiler generated this skeleton class from Slice interface ``::MumbleServer::ServerContextCallback``. + """ + + _ice_ids: Sequence[str] = ("::Ice::Object", "::MumbleServer::ServerContextCallback", ) + _op_contextAction: IcePy.Operation + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::ServerContextCallback" + + @abstractmethod + def contextAction(self, action: str, usr: User, session: int, channelid: int, current: Current) -> None | Awaitable[None]: + """ + Called when a context action is performed. + + Parameters + ---------- + action : str + Action to be performed. + usr : User + User which initiated the action. + session : int + If nonzero, session of target user. + channelid : int + If not -1, id of target channel. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + None | Awaitable[None] + None or an awaitable that completes when the dispatch completes. + """ + pass + +ServerContextCallback._op_contextAction = IcePy.Operation( + "contextAction", + "contextAction", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_string, False, 0), ((), _MumbleServer_User_t, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), + (), + None, + ()) + +__all__ = ["ServerContextCallback", "ServerContextCallbackPrx", "_MumbleServer_ServerContextCallbackPrx_t"] diff --git a/MumbleServer/ServerContextCallback_forward.py b/MumbleServer/ServerContextCallback_forward.py new file mode 100644 index 0000000..4b4b61f --- /dev/null +++ b/MumbleServer/ServerContextCallback_forward.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_ServerContextCallbackPrx_t = IcePy.declareProxy("::MumbleServer::ServerContextCallback") + +__all__ = ["_MumbleServer_ServerContextCallbackPrx_t"] \ No newline at end of file diff --git a/MumbleServer/ServerException.py b/MumbleServer/ServerException.py new file mode 100644 index 0000000..e7f786a --- /dev/null +++ b/MumbleServer/ServerException.py @@ -0,0 +1,32 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from Ice.UserException import UserException + +from dataclasses import dataclass + + +@dataclass +class ServerException(UserException): + """ + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::ServerException``. + """ + + _ice_id = "::MumbleServer::ServerException" + +_MumbleServer_ServerException_t = IcePy.defineException( + "::MumbleServer::ServerException", + ServerException, + (), + None, + ()) + +setattr(ServerException, '_ice_type', _MumbleServer_ServerException_t) + +__all__ = ["ServerException", "_MumbleServer_ServerException_t"] diff --git a/MumbleServer/ServerFailureException.py b/MumbleServer/ServerFailureException.py new file mode 100644 index 0000000..fa85dba --- /dev/null +++ b/MumbleServer/ServerFailureException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class ServerFailureException(ServerException): + """ + This is thrown if ``Server.start`` fails, and should generally be the cause for some concern. + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::ServerFailureException``. + """ + + _ice_id = "::MumbleServer::ServerFailureException" + +_MumbleServer_ServerFailureException_t = IcePy.defineException( + "::MumbleServer::ServerFailureException", + ServerFailureException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(ServerFailureException, '_ice_type', _MumbleServer_ServerFailureException_t) + +__all__ = ["ServerFailureException", "_MumbleServer_ServerFailureException_t"] diff --git a/MumbleServer/ServerList.py b/MumbleServer/ServerList.py new file mode 100644 index 0000000..4217866 --- /dev/null +++ b/MumbleServer/ServerList.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.Server_forward import _MumbleServer_ServerPrx_t + +_MumbleServer_ServerList_t = IcePy.defineSequence("::MumbleServer::ServerList", (), _MumbleServer_ServerPrx_t) + +__all__ = ["_MumbleServer_ServerList_t"] diff --git a/MumbleServer/ServerUpdatingAuthenticator.py b/MumbleServer/ServerUpdatingAuthenticator.py new file mode 100644 index 0000000..35875ac --- /dev/null +++ b/MumbleServer/ServerUpdatingAuthenticator.py @@ -0,0 +1,462 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from Ice.ObjectPrx import checkedCast +from Ice.ObjectPrx import checkedCastAsync +from Ice.ObjectPrx import uncheckedCast + +from Ice.OperationMode import OperationMode + +from MumbleServer.CertificateList import _MumbleServer_CertificateList_t + +from MumbleServer.GroupNameList import _MumbleServer_GroupNameList_t + +from MumbleServer.NameMap import _MumbleServer_NameMap_t + +from MumbleServer.ServerAuthenticator import ServerAuthenticator +from MumbleServer.ServerAuthenticator import ServerAuthenticatorPrx + +from MumbleServer.ServerUpdatingAuthenticator_forward import _MumbleServer_ServerUpdatingAuthenticatorPrx_t + +from MumbleServer.Texture import _MumbleServer_Texture_t + +from MumbleServer.UserInfoMap import _MumbleServer_UserInfoMap_t + +from abc import ABC +from abc import abstractmethod + +from typing import TYPE_CHECKING +from typing import overload + +if TYPE_CHECKING: + from Ice.Current import Current + from Ice.ObjectPrx import ObjectPrx + from MumbleServer.UserInfo import UserInfo + from collections.abc import Awaitable + from collections.abc import Buffer + from collections.abc import Mapping + from collections.abc import Sequence + + +class ServerUpdatingAuthenticatorPrx(ServerAuthenticatorPrx): + """ + 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``. + Almost all of these methods support fall through, meaning the server should continue the operation against its + own database. + + Notes + ----- + The Slice compiler generated this proxy class from Slice interface ``::MumbleServer::ServerUpdatingAuthenticator``. + """ + + def registerUser(self, info: Mapping[UserInfo, str], context: dict[str, str] | None = None) -> int: + """ + Register a new user. + + Parameters + ---------- + info : Mapping[UserInfo, str] + Information about user to register. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + User id of new user, -1 for registration failure, or -2 to fall through. + """ + return ServerUpdatingAuthenticator._op_registerUser.invoke(self, ((info, ), context)) + + def registerUserAsync(self, info: Mapping[UserInfo, str], context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Register a new user. + + Parameters + ---------- + info : Mapping[UserInfo, str] + Information about user to register. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + User id of new user, -1 for registration failure, or -2 to fall through. + """ + return ServerUpdatingAuthenticator._op_registerUser.invokeAsync(self, ((info, ), context)) + + def unregisterUser(self, id: int, context: dict[str, str] | None = None) -> int: + """ + Unregister a user. + + Parameters + ---------- + id : int + Userid to unregister. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + 1 for successful unregistration, 0 for unsuccessful unregistration, -1 to fall through. + """ + return ServerUpdatingAuthenticator._op_unregisterUser.invoke(self, ((id, ), context)) + + def unregisterUserAsync(self, id: int, context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Unregister a user. + + Parameters + ---------- + id : int + Userid to unregister. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + 1 for successful unregistration, 0 for unsuccessful unregistration, -1 to fall through. + """ + return ServerUpdatingAuthenticator._op_unregisterUser.invokeAsync(self, ((id, ), context)) + + def getRegisteredUsers(self, filter: str, context: dict[str, str] | None = None) -> dict[int, str]: + """ + Get a list of registered users matching filter. + + Parameters + ---------- + filter : str + Substring usernames must contain. If empty, return all registered users. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + dict[int, str] + List of matching registered users. + """ + return ServerUpdatingAuthenticator._op_getRegisteredUsers.invoke(self, ((filter, ), context)) + + def getRegisteredUsersAsync(self, filter: str, context: dict[str, str] | None = None) -> Awaitable[dict[int, str]]: + """ + Get a list of registered users matching filter. + + Parameters + ---------- + filter : str + Substring usernames must contain. If empty, return all registered users. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[dict[int, str]] + List of matching registered users. + """ + return ServerUpdatingAuthenticator._op_getRegisteredUsers.invokeAsync(self, ((filter, ), context)) + + def setInfo(self, id: int, info: Mapping[UserInfo, str], context: dict[str, str] | None = None) -> int: + """ + Set additional information for user registration. + + Parameters + ---------- + id : int + Userid of registered user. + info : Mapping[UserInfo, str] + Information to set about user. This should be merged with existing information. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + 1 for successful update, 0 for unsuccessful update, -1 to fall through. + """ + return ServerUpdatingAuthenticator._op_setInfo.invoke(self, ((id, info), context)) + + def setInfoAsync(self, id: int, info: Mapping[UserInfo, str], context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Set additional information for user registration. + + Parameters + ---------- + id : int + Userid of registered user. + info : Mapping[UserInfo, str] + Information to set about user. This should be merged with existing information. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + 1 for successful update, 0 for unsuccessful update, -1 to fall through. + """ + return ServerUpdatingAuthenticator._op_setInfo.invokeAsync(self, ((id, info), context)) + + def setTexture(self, id: int, tex: Sequence[int] | bytes | Buffer, context: dict[str, str] | None = None) -> int: + """ + Set texture (now called avatar) of user registration. + + Parameters + ---------- + id : int + registrationId of registered user. + tex : Sequence[int] | bytes | Buffer + New texture. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + int + 1 for successful update, 0 for unsuccessful update, -1 to fall through. + """ + return ServerUpdatingAuthenticator._op_setTexture.invoke(self, ((id, tex), context)) + + def setTextureAsync(self, id: int, tex: Sequence[int] | bytes | Buffer, context: dict[str, str] | None = None) -> Awaitable[int]: + """ + Set texture (now called avatar) of user registration. + + Parameters + ---------- + id : int + registrationId of registered user. + tex : Sequence[int] | bytes | Buffer + New texture. + context : dict[str, str] + The request context for the invocation. + + Returns + ------- + Awaitable[int] + 1 for successful update, 0 for unsuccessful update, -1 to fall through. + """ + return ServerUpdatingAuthenticator._op_setTexture.invokeAsync(self, ((id, tex), context)) + + @staticmethod + def checkedCast( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> ServerUpdatingAuthenticatorPrx | None: + return checkedCast(ServerUpdatingAuthenticatorPrx, proxy, facet, context) + + @staticmethod + def checkedCastAsync( + proxy: ObjectPrx | None, + facet: str | None = None, + context: dict[str, str] | None = None + ) -> Awaitable[ServerUpdatingAuthenticatorPrx | None ]: + return checkedCastAsync(ServerUpdatingAuthenticatorPrx, proxy, facet, context) + + @overload + @staticmethod + def uncheckedCast(proxy: ObjectPrx, facet: str | None = None) -> ServerUpdatingAuthenticatorPrx: + ... + + @overload + @staticmethod + def uncheckedCast(proxy: None, facet: str | None = None) -> None: + ... + + @staticmethod + def uncheckedCast(proxy: ObjectPrx | None, facet: str | None = None) -> ServerUpdatingAuthenticatorPrx | None: + return uncheckedCast(ServerUpdatingAuthenticatorPrx, proxy, facet) + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::ServerUpdatingAuthenticator" + +IcePy.defineProxy("::MumbleServer::ServerUpdatingAuthenticator", ServerUpdatingAuthenticatorPrx) + +class ServerUpdatingAuthenticator(ServerAuthenticator, ABC): + """ + 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``. + Almost all of these methods support fall through, meaning the server should continue the operation against its + own database. + + Notes + ----- + The Slice compiler generated this skeleton class from Slice interface ``::MumbleServer::ServerUpdatingAuthenticator``. + """ + + _ice_ids: Sequence[str] = ("::Ice::Object", "::MumbleServer::ServerAuthenticator", "::MumbleServer::ServerUpdatingAuthenticator", ) + _op_registerUser: IcePy.Operation + _op_unregisterUser: IcePy.Operation + _op_getRegisteredUsers: IcePy.Operation + _op_setInfo: IcePy.Operation + _op_setTexture: IcePy.Operation + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::ServerUpdatingAuthenticator" + + @abstractmethod + def registerUser(self, info: dict[UserInfo, str], current: Current) -> int | Awaitable[int]: + """ + Register a new user. + + Parameters + ---------- + info : dict[UserInfo, str] + Information about user to register. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + User id of new user, -1 for registration failure, or -2 to fall through. + """ + pass + + @abstractmethod + def unregisterUser(self, id: int, current: Current) -> int | Awaitable[int]: + """ + Unregister a user. + + Parameters + ---------- + id : int + Userid to unregister. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + 1 for successful unregistration, 0 for unsuccessful unregistration, -1 to fall through. + """ + pass + + @abstractmethod + def getRegisteredUsers(self, filter: str, current: Current) -> Mapping[int, str] | Awaitable[Mapping[int, str]]: + """ + Get a list of registered users matching filter. + + Parameters + ---------- + filter : str + Substring usernames must contain. If empty, return all registered users. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + Mapping[int, str] | Awaitable[Mapping[int, str]] + List of matching registered users. + """ + pass + + @abstractmethod + def setInfo(self, id: int, info: dict[UserInfo, str], current: Current) -> int | Awaitable[int]: + """ + Set additional information for user registration. + + Parameters + ---------- + id : int + Userid of registered user. + info : dict[UserInfo, str] + Information to set about user. This should be merged with existing information. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + 1 for successful update, 0 for unsuccessful update, -1 to fall through. + """ + pass + + @abstractmethod + def setTexture(self, id: int, tex: bytes, current: Current) -> int | Awaitable[int]: + """ + Set texture (now called avatar) of user registration. + + Parameters + ---------- + id : int + registrationId of registered user. + tex : bytes + New texture. + current : Ice.Current + The Current object for the dispatch. + + Returns + ------- + int | Awaitable[int] + 1 for successful update, 0 for unsuccessful update, -1 to fall through. + """ + pass + +ServerUpdatingAuthenticator._op_registerUser = IcePy.Operation( + "registerUser", + "registerUser", + OperationMode.Normal, + None, + (), + (((), _MumbleServer_UserInfoMap_t, False, 0),), + (), + ((), IcePy._t_int, False, 0), + ()) + +ServerUpdatingAuthenticator._op_unregisterUser = IcePy.Operation( + "unregisterUser", + "unregisterUser", + OperationMode.Normal, + None, + (), + (((), IcePy._t_int, False, 0),), + (), + ((), IcePy._t_int, False, 0), + ()) + +ServerUpdatingAuthenticator._op_getRegisteredUsers = IcePy.Operation( + "getRegisteredUsers", + "getRegisteredUsers", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_string, False, 0),), + (), + ((), _MumbleServer_NameMap_t, False, 0), + ()) + +ServerUpdatingAuthenticator._op_setInfo = IcePy.Operation( + "setInfo", + "setInfo", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), _MumbleServer_UserInfoMap_t, False, 0)), + (), + ((), IcePy._t_int, False, 0), + ()) + +ServerUpdatingAuthenticator._op_setTexture = IcePy.Operation( + "setTexture", + "setTexture", + OperationMode.Idempotent, + None, + (), + (((), IcePy._t_int, False, 0), ((), _MumbleServer_Texture_t, False, 0)), + (), + ((), IcePy._t_int, False, 0), + ()) + +__all__ = ["ServerUpdatingAuthenticator", "ServerUpdatingAuthenticatorPrx", "_MumbleServer_ServerUpdatingAuthenticatorPrx_t"] diff --git a/MumbleServer/ServerUpdatingAuthenticator_forward.py b/MumbleServer/ServerUpdatingAuthenticator_forward.py new file mode 100644 index 0000000..ec313b1 --- /dev/null +++ b/MumbleServer/ServerUpdatingAuthenticator_forward.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_ServerUpdatingAuthenticatorPrx_t = IcePy.declareProxy("::MumbleServer::ServerUpdatingAuthenticator") + +__all__ = ["_MumbleServer_ServerUpdatingAuthenticatorPrx_t"] \ No newline at end of file diff --git a/MumbleServer/Server_forward.py b/MumbleServer/Server_forward.py new file mode 100644 index 0000000..0cb0b41 --- /dev/null +++ b/MumbleServer/Server_forward.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_ServerPrx_t = IcePy.declareProxy("::MumbleServer::Server") + +__all__ = ["_MumbleServer_ServerPrx_t"] \ No newline at end of file diff --git a/MumbleServer/TextMessage.py b/MumbleServer/TextMessage.py new file mode 100644 index 0000000..3915c24 --- /dev/null +++ b/MumbleServer/TextMessage.py @@ -0,0 +1,55 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.IntList import _MumbleServer_IntList_t + +from dataclasses import dataclass +from dataclasses import field + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from collections.abc import Buffer + + +@dataclass +class TextMessage: + """ + A text message between users. + + Attributes + ---------- + sessions : list[int] + Sessions (connected users) who were sent this message. + channels : list[int] + Channels who were sent this message. + trees : list[int] + Trees of channels who were sent this message. + text : str + The contents of the message. + + Notes + ----- + The Slice compiler generated this dataclass from Slice struct ``::MumbleServer::TextMessage``. + """ + sessions: list[int] = field(default_factory=list) + channels: list[int] = field(default_factory=list) + trees: list[int] = field(default_factory=list) + text: str = "" + +_MumbleServer_TextMessage_t = IcePy.defineStruct( + "::MumbleServer::TextMessage", + TextMessage, + (), + ( + ("sessions", (), _MumbleServer_IntList_t), + ("channels", (), _MumbleServer_IntList_t), + ("trees", (), _MumbleServer_IntList_t), + ("text", (), IcePy._t_string) + )) + +__all__ = ["TextMessage", "_MumbleServer_TextMessage_t"] diff --git a/MumbleServer/Texture.py b/MumbleServer/Texture.py new file mode 100644 index 0000000..e253a97 --- /dev/null +++ b/MumbleServer/Texture.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_Texture_t = IcePy.defineSequence("::MumbleServer::Texture", (), IcePy._t_byte) + +__all__ = ["_MumbleServer_Texture_t"] diff --git a/MumbleServer/Tree.py b/MumbleServer/Tree.py new file mode 100644 index 0000000..4ff7e14 --- /dev/null +++ b/MumbleServer/Tree.py @@ -0,0 +1,68 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from Ice.Value import Value + +from MumbleServer.Channel import Channel +from MumbleServer.Channel import _MumbleServer_Channel_t + +from MumbleServer.TreeList import _MumbleServer_TreeList_t + +from MumbleServer.Tree_forward import _MumbleServer_Tree_t + +from MumbleServer.UserList import _MumbleServer_UserList_t + +from dataclasses import dataclass +from dataclasses import field + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from MumbleServer.User import User + +@dataclass(eq=False) +class Tree(Value): + """ + User and subchannel state. Read-only. + + Attributes + ---------- + c : Channel + Channel definition of current channel. + children : list[Tree | None] + List of subchannels. + users : list[User] + Users in this channel. + + Notes + ----- + The Slice compiler generated this dataclass from Slice class ``::MumbleServer::Tree``. + """ + c: Channel = field(default_factory=Channel) + children: list[Tree | None] = field(default_factory=list) + users: list[User] = field(default_factory=list) + + @staticmethod + def ice_staticId() -> str: + return "::MumbleServer::Tree" + +_MumbleServer_Tree_t = IcePy.defineValue( + "::MumbleServer::Tree", + Tree, + -1, + (), + False, + None, + ( + ("c", (), _MumbleServer_Channel_t, False, 0), + ("children", (), _MumbleServer_TreeList_t, False, 0), + ("users", (), _MumbleServer_UserList_t, False, 0) + )) + +setattr(Tree, '_ice_type', _MumbleServer_Tree_t) + +__all__ = ["Tree", "_MumbleServer_Tree_t"] diff --git a/MumbleServer/TreeList.py b/MumbleServer/TreeList.py new file mode 100644 index 0000000..3098aab --- /dev/null +++ b/MumbleServer/TreeList.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.Tree_forward import _MumbleServer_Tree_t + +_MumbleServer_TreeList_t = IcePy.defineSequence("::MumbleServer::TreeList", (), _MumbleServer_Tree_t) + +__all__ = ["_MumbleServer_TreeList_t"] diff --git a/MumbleServer/Tree_forward.py b/MumbleServer/Tree_forward.py new file mode 100644 index 0000000..0751b5c --- /dev/null +++ b/MumbleServer/Tree_forward.py @@ -0,0 +1,10 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +_MumbleServer_Tree_t = IcePy.declareValue("::MumbleServer::Tree") + +__all__ = ["_MumbleServer_Tree_t"] \ No newline at end of file diff --git a/MumbleServer/User.py b/MumbleServer/User.py new file mode 100644 index 0000000..4a1623a --- /dev/null +++ b/MumbleServer/User.py @@ -0,0 +1,153 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.NetAddress import _MumbleServer_NetAddress_t + +from dataclasses import dataclass +from dataclasses import field + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from collections.abc import Buffer + + +@dataclass +class User: + """ + A connected user. + + Attributes + ---------- + session : int + Session ID. This identifies the connection to the server. + userid : int + User ID. -1 if the user is anonymous. + mute : bool + Is user muted by the server? + deaf : bool + Is user deafened by the server? If true, this implies mute. + suppress : bool + Is the user suppressed by the server? This means the user is not muted, but does not have speech privileges in the current channel. + prioritySpeaker : bool + Is the user a priority speaker? + selfMute : bool + Is the user self-muted? + selfDeaf : bool + Is the user self-deafened? If true, this implies mute. + recording : bool + Is the User recording? (This flag is read-only and cannot be changed using setState().) + channel : int + Channel ID the user is in. Matches ``Channel.id``. + name : str + The name of the user. + onlinesecs : int + Seconds user has been online. + bytespersec : int + Average transmission rate in bytes per second over the last few seconds. + version : int + Legacy client version. + version2 : int + New client version. (See https://github.com/mumble-voip/mumble/issues/5827) + release : str + Client release. For official releases, this equals the version. For snapshots and git compiles, this will be something else. + os : str + Client OS. + osversion : str + Client OS Version. + identity : str + Plugin Identity. This will be the user's unique ID inside the current game. + context : str + Base64-encoded Plugin context. This is a binary blob identifying the game and team the user is on. + + The used Base64 alphabet is the one specified in RFC 2045. + + Before Mumble 1.3.0, this string was not Base64-encoded. This could cause problems for some Ice + implementations, such as the .NET implementation. + + If you need the exact string that is used by Mumble, you can get it by Base64-decoding this string. + + If you simply need to detect whether two users are in the same game world, string comparisons will + continue to work as before. + comment : str + User comment. Shown as tooltip for this user. + address : bytes + Client address. + tcponly : bool + TCP only. True until UDP connectivity is established. + idlesecs : int + Idle time. This is how many seconds it is since the user last spoke. Other activity is not counted. + udpPing : float + UDP Ping Average. This is the average ping for the user via UDP over the duration of the connection. + tcpPing : float + TCP Ping Average. This is the average ping for the user via TCP over the duration of the connection. + + Notes + ----- + The Slice compiler generated this dataclass from Slice struct ``::MumbleServer::User``. + """ + session: int = 0 + userid: int = 0 + mute: bool = False + deaf: bool = False + suppress: bool = False + prioritySpeaker: bool = False + selfMute: bool = False + selfDeaf: bool = False + recording: bool = False + channel: int = 0 + name: str = "" + onlinesecs: int = 0 + bytespersec: int = 0 + version: int = 0 + version2: int = 0 + release: str = "" + os: str = "" + osversion: str = "" + identity: str = "" + context: str = "" + comment: str = "" + address: bytes = field(default_factory=bytes) + tcponly: bool = False + idlesecs: int = 0 + udpPing: float = 0.0 + tcpPing: float = 0.0 + +_MumbleServer_User_t = IcePy.defineStruct( + "::MumbleServer::User", + User, + (), + ( + ("session", (), IcePy._t_int), + ("userid", (), IcePy._t_int), + ("mute", (), IcePy._t_bool), + ("deaf", (), IcePy._t_bool), + ("suppress", (), IcePy._t_bool), + ("prioritySpeaker", (), IcePy._t_bool), + ("selfMute", (), IcePy._t_bool), + ("selfDeaf", (), IcePy._t_bool), + ("recording", (), IcePy._t_bool), + ("channel", (), IcePy._t_int), + ("name", (), IcePy._t_string), + ("onlinesecs", (), IcePy._t_int), + ("bytespersec", (), IcePy._t_int), + ("version", (), IcePy._t_int), + ("version2", (), IcePy._t_long), + ("release", (), IcePy._t_string), + ("os", (), IcePy._t_string), + ("osversion", (), IcePy._t_string), + ("identity", (), IcePy._t_string), + ("context", (), IcePy._t_string), + ("comment", (), IcePy._t_string), + ("address", (), _MumbleServer_NetAddress_t), + ("tcponly", (), IcePy._t_bool), + ("idlesecs", (), IcePy._t_int), + ("udpPing", (), IcePy._t_float), + ("tcpPing", (), IcePy._t_float) + )) + +__all__ = ["User", "_MumbleServer_User_t"] diff --git a/MumbleServer/UserInfo.py b/MumbleServer/UserInfo.py new file mode 100644 index 0000000..e9a659b --- /dev/null +++ b/MumbleServer/UserInfo.py @@ -0,0 +1,46 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from enum import Enum + +class UserInfo(Enum): + """ + Notes + ----- + The Slice compiler generated this enum class from Slice enumeration ``::MumbleServer::UserInfo``. + """ + + UserName = 0 + + UserEmail = 1 + + UserComment = 2 + + UserHash = 3 + + UserPassword = 4 + + UserLastActive = 5 + + UserKDFIterations = 6 + +_MumbleServer_UserInfo_t = IcePy.defineEnum( + "::MumbleServer::UserInfo", + UserInfo, + (), + { + 0: UserInfo.UserName, + 1: UserInfo.UserEmail, + 2: UserInfo.UserComment, + 3: UserInfo.UserHash, + 4: UserInfo.UserPassword, + 5: UserInfo.UserLastActive, + 6: UserInfo.UserKDFIterations, + } +) + +__all__ = ["UserInfo", "_MumbleServer_UserInfo_t"] diff --git a/MumbleServer/UserInfoMap.py b/MumbleServer/UserInfoMap.py new file mode 100644 index 0000000..efb4366 --- /dev/null +++ b/MumbleServer/UserInfoMap.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.UserInfo import _MumbleServer_UserInfo_t + +_MumbleServer_UserInfoMap_t = IcePy.defineDictionary("::MumbleServer::UserInfoMap", (), _MumbleServer_UserInfo_t, IcePy._t_string) + +__all__ = ["_MumbleServer_UserInfoMap_t"] diff --git a/MumbleServer/UserList.py b/MumbleServer/UserList.py new file mode 100644 index 0000000..81eb1e5 --- /dev/null +++ b/MumbleServer/UserList.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.User import _MumbleServer_User_t + +_MumbleServer_UserList_t = IcePy.defineSequence("::MumbleServer::UserList", (), _MumbleServer_User_t) + +__all__ = ["_MumbleServer_UserList_t"] diff --git a/MumbleServer/UserMap.py b/MumbleServer/UserMap.py new file mode 100644 index 0000000..8ab7383 --- /dev/null +++ b/MumbleServer/UserMap.py @@ -0,0 +1,12 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.User import _MumbleServer_User_t + +_MumbleServer_UserMap_t = IcePy.defineDictionary("::MumbleServer::UserMap", (), IcePy._t_int, _MumbleServer_User_t) + +__all__ = ["_MumbleServer_UserMap_t"] diff --git a/MumbleServer/WriteOnlyException.py b/MumbleServer/WriteOnlyException.py new file mode 100644 index 0000000..9465345 --- /dev/null +++ b/MumbleServer/WriteOnlyException.py @@ -0,0 +1,35 @@ +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from __future__ import annotations +import IcePy + +from MumbleServer.ServerException import ServerException +from MumbleServer.ServerException import _MumbleServer_ServerException_t + +from dataclasses import dataclass + + +@dataclass +class WriteOnlyException(ServerException): + """ + This is thrown when you ask the server to disclose something that should be secret. + + Notes + ----- + The Slice compiler generated this exception dataclass from Slice exception ``::MumbleServer::WriteOnlyException``. + """ + + _ice_id = "::MumbleServer::WriteOnlyException" + +_MumbleServer_WriteOnlyException_t = IcePy.defineException( + "::MumbleServer::WriteOnlyException", + WriteOnlyException, + (), + _MumbleServer_ServerException_t, + ()) + +setattr(WriteOnlyException, '_ice_type', _MumbleServer_WriteOnlyException_t) + +__all__ = ["WriteOnlyException", "_MumbleServer_WriteOnlyException_t"] diff --git a/MumbleServer/__init__.py b/MumbleServer/__init__.py new file mode 100644 index 0000000..f93d8bd --- /dev/null +++ b/MumbleServer/__init__.py @@ -0,0 +1,241 @@ + +# Copyright (c) ZeroC, Inc. + +# slice2py version 3.8.1 + +from .ACL import ACL +from .ACL import _MumbleServer_ACL_t +from .ACLList import _MumbleServer_ACLList_t +from .Ban import Ban +from .Ban import _MumbleServer_Ban_t +from .BanList import _MumbleServer_BanList_t +from .CertificateDer import _MumbleServer_CertificateDer_t +from .CertificateList import _MumbleServer_CertificateList_t +from .Channel import Channel +from .Channel import _MumbleServer_Channel_t +from .ChannelInfo import ChannelInfo +from .ChannelInfo import _MumbleServer_ChannelInfo_t +from .ChannelList import _MumbleServer_ChannelList_t +from .ChannelMap import _MumbleServer_ChannelMap_t +from .ConfigMap import _MumbleServer_ConfigMap_t +from .ContextChannel import ContextChannel +from .ContextServer import ContextServer +from .ContextUser import ContextUser +from .DBState import DBState +from .DBState import _MumbleServer_DBState_t +from .Group import Group +from .Group import _MumbleServer_Group_t +from .GroupList import _MumbleServer_GroupList_t +from .GroupNameList import _MumbleServer_GroupNameList_t +from .IdList import _MumbleServer_IdList_t +from .IdMap import _MumbleServer_IdMap_t +from .IntList import _MumbleServer_IntList_t +from .InternalErrorException import InternalErrorException +from .InternalErrorException import _MumbleServer_InternalErrorException_t +from .InvalidCallbackException import InvalidCallbackException +from .InvalidCallbackException import _MumbleServer_InvalidCallbackException_t +from .InvalidChannelException import InvalidChannelException +from .InvalidChannelException import _MumbleServer_InvalidChannelException_t +from .InvalidInputDataException import InvalidInputDataException +from .InvalidInputDataException import _MumbleServer_InvalidInputDataException_t +from .InvalidListenerException import InvalidListenerException +from .InvalidListenerException import _MumbleServer_InvalidListenerException_t +from .InvalidSecretException import InvalidSecretException +from .InvalidSecretException import _MumbleServer_InvalidSecretException_t +from .InvalidServerException import InvalidServerException +from .InvalidServerException import _MumbleServer_InvalidServerException_t +from .InvalidSessionException import InvalidSessionException +from .InvalidSessionException import _MumbleServer_InvalidSessionException_t +from .InvalidTextureException import InvalidTextureException +from .InvalidTextureException import _MumbleServer_InvalidTextureException_t +from .InvalidUserException import InvalidUserException +from .InvalidUserException import _MumbleServer_InvalidUserException_t +from .LogEntry import LogEntry +from .LogEntry import _MumbleServer_LogEntry_t +from .LogList import _MumbleServer_LogList_t +from .Meta import Meta +from .Meta import MetaPrx +from .MetaCallback import MetaCallback +from .MetaCallback import MetaCallbackPrx +from .MetaCallback_forward import _MumbleServer_MetaCallbackPrx_t +from .Meta_forward import _MumbleServer_MetaPrx_t +from .NameList import _MumbleServer_NameList_t +from .NameMap import _MumbleServer_NameMap_t +from .NestingLimitException import NestingLimitException +from .NestingLimitException import _MumbleServer_NestingLimitException_t +from .NetAddress import _MumbleServer_NetAddress_t +from .PermissionBan import PermissionBan +from .PermissionEnter import PermissionEnter +from .PermissionKick import PermissionKick +from .PermissionLinkChannel import PermissionLinkChannel +from .PermissionMakeChannel import PermissionMakeChannel +from .PermissionMakeTempChannel import PermissionMakeTempChannel +from .PermissionMove import PermissionMove +from .PermissionMuteDeafen import PermissionMuteDeafen +from .PermissionRegister import PermissionRegister +from .PermissionRegisterSelf import PermissionRegisterSelf +from .PermissionSpeak import PermissionSpeak +from .PermissionTextMessage import PermissionTextMessage +from .PermissionTraverse import PermissionTraverse +from .PermissionWhisper import PermissionWhisper +from .PermissionWrite import PermissionWrite +from .ReadOnlyModeException import ReadOnlyModeException +from .ReadOnlyModeException import _MumbleServer_ReadOnlyModeException_t +from .ResetUserContent import ResetUserContent +from .Server import Server +from .Server import ServerPrx +from .ServerAuthenticator import ServerAuthenticator +from .ServerAuthenticator import ServerAuthenticatorPrx +from .ServerAuthenticator_forward import _MumbleServer_ServerAuthenticatorPrx_t +from .ServerBootedException import ServerBootedException +from .ServerBootedException import _MumbleServer_ServerBootedException_t +from .ServerCallback import ServerCallback +from .ServerCallback import ServerCallbackPrx +from .ServerCallback_forward import _MumbleServer_ServerCallbackPrx_t +from .ServerContextCallback import ServerContextCallback +from .ServerContextCallback import ServerContextCallbackPrx +from .ServerContextCallback_forward import _MumbleServer_ServerContextCallbackPrx_t +from .ServerException import ServerException +from .ServerException import _MumbleServer_ServerException_t +from .ServerFailureException import ServerFailureException +from .ServerFailureException import _MumbleServer_ServerFailureException_t +from .ServerList import _MumbleServer_ServerList_t +from .ServerUpdatingAuthenticator import ServerUpdatingAuthenticator +from .ServerUpdatingAuthenticator import ServerUpdatingAuthenticatorPrx +from .ServerUpdatingAuthenticator_forward import _MumbleServer_ServerUpdatingAuthenticatorPrx_t +from .Server_forward import _MumbleServer_ServerPrx_t +from .TextMessage import TextMessage +from .TextMessage import _MumbleServer_TextMessage_t +from .Texture import _MumbleServer_Texture_t +from .Tree import Tree +from .TreeList import _MumbleServer_TreeList_t +from .Tree_forward import _MumbleServer_Tree_t +from .User import User +from .User import _MumbleServer_User_t +from .UserInfo import UserInfo +from .UserInfo import _MumbleServer_UserInfo_t +from .UserInfoMap import _MumbleServer_UserInfoMap_t +from .UserList import _MumbleServer_UserList_t +from .UserMap import _MumbleServer_UserMap_t +from .WriteOnlyException import WriteOnlyException +from .WriteOnlyException import _MumbleServer_WriteOnlyException_t + + +__all__ = [ + "ACL", + "_MumbleServer_ACL_t", + "_MumbleServer_ACLList_t", + "Ban", + "_MumbleServer_Ban_t", + "_MumbleServer_BanList_t", + "_MumbleServer_CertificateDer_t", + "_MumbleServer_CertificateList_t", + "Channel", + "_MumbleServer_Channel_t", + "ChannelInfo", + "_MumbleServer_ChannelInfo_t", + "_MumbleServer_ChannelList_t", + "_MumbleServer_ChannelMap_t", + "_MumbleServer_ConfigMap_t", + "ContextChannel", + "ContextServer", + "ContextUser", + "DBState", + "_MumbleServer_DBState_t", + "Group", + "_MumbleServer_Group_t", + "_MumbleServer_GroupList_t", + "_MumbleServer_GroupNameList_t", + "_MumbleServer_IdList_t", + "_MumbleServer_IdMap_t", + "_MumbleServer_IntList_t", + "InternalErrorException", + "_MumbleServer_InternalErrorException_t", + "InvalidCallbackException", + "_MumbleServer_InvalidCallbackException_t", + "InvalidChannelException", + "_MumbleServer_InvalidChannelException_t", + "InvalidInputDataException", + "_MumbleServer_InvalidInputDataException_t", + "InvalidListenerException", + "_MumbleServer_InvalidListenerException_t", + "InvalidSecretException", + "_MumbleServer_InvalidSecretException_t", + "InvalidServerException", + "_MumbleServer_InvalidServerException_t", + "InvalidSessionException", + "_MumbleServer_InvalidSessionException_t", + "InvalidTextureException", + "_MumbleServer_InvalidTextureException_t", + "InvalidUserException", + "_MumbleServer_InvalidUserException_t", + "LogEntry", + "_MumbleServer_LogEntry_t", + "_MumbleServer_LogList_t", + "Meta", + "MetaPrx", + "MetaCallback", + "MetaCallbackPrx", + "_MumbleServer_MetaCallbackPrx_t", + "_MumbleServer_MetaPrx_t", + "_MumbleServer_NameList_t", + "_MumbleServer_NameMap_t", + "NestingLimitException", + "_MumbleServer_NestingLimitException_t", + "_MumbleServer_NetAddress_t", + "PermissionBan", + "PermissionEnter", + "PermissionKick", + "PermissionLinkChannel", + "PermissionMakeChannel", + "PermissionMakeTempChannel", + "PermissionMove", + "PermissionMuteDeafen", + "PermissionRegister", + "PermissionRegisterSelf", + "PermissionSpeak", + "PermissionTextMessage", + "PermissionTraverse", + "PermissionWhisper", + "PermissionWrite", + "ReadOnlyModeException", + "_MumbleServer_ReadOnlyModeException_t", + "ResetUserContent", + "Server", + "ServerPrx", + "ServerAuthenticator", + "ServerAuthenticatorPrx", + "_MumbleServer_ServerAuthenticatorPrx_t", + "ServerBootedException", + "_MumbleServer_ServerBootedException_t", + "ServerCallback", + "ServerCallbackPrx", + "_MumbleServer_ServerCallbackPrx_t", + "ServerContextCallback", + "ServerContextCallbackPrx", + "_MumbleServer_ServerContextCallbackPrx_t", + "ServerException", + "_MumbleServer_ServerException_t", + "ServerFailureException", + "_MumbleServer_ServerFailureException_t", + "_MumbleServer_ServerList_t", + "ServerUpdatingAuthenticator", + "ServerUpdatingAuthenticatorPrx", + "_MumbleServer_ServerUpdatingAuthenticatorPrx_t", + "_MumbleServer_ServerPrx_t", + "TextMessage", + "_MumbleServer_TextMessage_t", + "_MumbleServer_Texture_t", + "Tree", + "_MumbleServer_TreeList_t", + "_MumbleServer_Tree_t", + "User", + "_MumbleServer_User_t", + "UserInfo", + "_MumbleServer_UserInfo_t", + "_MumbleServer_UserInfoMap_t", + "_MumbleServer_UserList_t", + "_MumbleServer_UserMap_t", + "WriteOnlyException", + "_MumbleServer_WriteOnlyException_t" +] diff --git a/MumbleServer/__pycache__/ACL.cpython-312.pyc b/MumbleServer/__pycache__/ACL.cpython-312.pyc new file mode 100644 index 0000000..b9828ef Binary files /dev/null and b/MumbleServer/__pycache__/ACL.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ACLList.cpython-312.pyc b/MumbleServer/__pycache__/ACLList.cpython-312.pyc new file mode 100644 index 0000000..af4dc54 Binary files /dev/null and b/MumbleServer/__pycache__/ACLList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/Ban.cpython-312.pyc b/MumbleServer/__pycache__/Ban.cpython-312.pyc new file mode 100644 index 0000000..1f9321e Binary files /dev/null and b/MumbleServer/__pycache__/Ban.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/BanList.cpython-312.pyc b/MumbleServer/__pycache__/BanList.cpython-312.pyc new file mode 100644 index 0000000..3604561 Binary files /dev/null and b/MumbleServer/__pycache__/BanList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/CertificateDer.cpython-312.pyc b/MumbleServer/__pycache__/CertificateDer.cpython-312.pyc new file mode 100644 index 0000000..5ce771e Binary files /dev/null and b/MumbleServer/__pycache__/CertificateDer.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/CertificateList.cpython-312.pyc b/MumbleServer/__pycache__/CertificateList.cpython-312.pyc new file mode 100644 index 0000000..319a417 Binary files /dev/null and b/MumbleServer/__pycache__/CertificateList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/Channel.cpython-312.pyc b/MumbleServer/__pycache__/Channel.cpython-312.pyc new file mode 100644 index 0000000..cf42a21 Binary files /dev/null and b/MumbleServer/__pycache__/Channel.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ChannelInfo.cpython-312.pyc b/MumbleServer/__pycache__/ChannelInfo.cpython-312.pyc new file mode 100644 index 0000000..199c342 Binary files /dev/null and b/MumbleServer/__pycache__/ChannelInfo.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ChannelList.cpython-312.pyc b/MumbleServer/__pycache__/ChannelList.cpython-312.pyc new file mode 100644 index 0000000..ac187b2 Binary files /dev/null and b/MumbleServer/__pycache__/ChannelList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ChannelMap.cpython-312.pyc b/MumbleServer/__pycache__/ChannelMap.cpython-312.pyc new file mode 100644 index 0000000..41211e2 Binary files /dev/null and b/MumbleServer/__pycache__/ChannelMap.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ConfigMap.cpython-312.pyc b/MumbleServer/__pycache__/ConfigMap.cpython-312.pyc new file mode 100644 index 0000000..56a4b4a Binary files /dev/null and b/MumbleServer/__pycache__/ConfigMap.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ContextChannel.cpython-312.pyc b/MumbleServer/__pycache__/ContextChannel.cpython-312.pyc new file mode 100644 index 0000000..c364ac8 Binary files /dev/null and b/MumbleServer/__pycache__/ContextChannel.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ContextServer.cpython-312.pyc b/MumbleServer/__pycache__/ContextServer.cpython-312.pyc new file mode 100644 index 0000000..37d67a5 Binary files /dev/null and b/MumbleServer/__pycache__/ContextServer.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ContextUser.cpython-312.pyc b/MumbleServer/__pycache__/ContextUser.cpython-312.pyc new file mode 100644 index 0000000..46f2dd3 Binary files /dev/null and b/MumbleServer/__pycache__/ContextUser.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/DBState.cpython-312.pyc b/MumbleServer/__pycache__/DBState.cpython-312.pyc new file mode 100644 index 0000000..8dff2e6 Binary files /dev/null and b/MumbleServer/__pycache__/DBState.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/Group.cpython-312.pyc b/MumbleServer/__pycache__/Group.cpython-312.pyc new file mode 100644 index 0000000..0938a5a Binary files /dev/null and b/MumbleServer/__pycache__/Group.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/GroupList.cpython-312.pyc b/MumbleServer/__pycache__/GroupList.cpython-312.pyc new file mode 100644 index 0000000..b8c4645 Binary files /dev/null and b/MumbleServer/__pycache__/GroupList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/GroupNameList.cpython-312.pyc b/MumbleServer/__pycache__/GroupNameList.cpython-312.pyc new file mode 100644 index 0000000..40cab92 Binary files /dev/null and b/MumbleServer/__pycache__/GroupNameList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/IdList.cpython-312.pyc b/MumbleServer/__pycache__/IdList.cpython-312.pyc new file mode 100644 index 0000000..1f648fc Binary files /dev/null and b/MumbleServer/__pycache__/IdList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/IdMap.cpython-312.pyc b/MumbleServer/__pycache__/IdMap.cpython-312.pyc new file mode 100644 index 0000000..892bc16 Binary files /dev/null and b/MumbleServer/__pycache__/IdMap.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/IntList.cpython-312.pyc b/MumbleServer/__pycache__/IntList.cpython-312.pyc new file mode 100644 index 0000000..199017e Binary files /dev/null and b/MumbleServer/__pycache__/IntList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/InternalErrorException.cpython-312.pyc b/MumbleServer/__pycache__/InternalErrorException.cpython-312.pyc new file mode 100644 index 0000000..8ab1686 Binary files /dev/null and b/MumbleServer/__pycache__/InternalErrorException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/InvalidCallbackException.cpython-312.pyc b/MumbleServer/__pycache__/InvalidCallbackException.cpython-312.pyc new file mode 100644 index 0000000..ce44127 Binary files /dev/null and b/MumbleServer/__pycache__/InvalidCallbackException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/InvalidChannelException.cpython-312.pyc b/MumbleServer/__pycache__/InvalidChannelException.cpython-312.pyc new file mode 100644 index 0000000..acf866d Binary files /dev/null and b/MumbleServer/__pycache__/InvalidChannelException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/InvalidInputDataException.cpython-312.pyc b/MumbleServer/__pycache__/InvalidInputDataException.cpython-312.pyc new file mode 100644 index 0000000..8fd034f Binary files /dev/null and b/MumbleServer/__pycache__/InvalidInputDataException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/InvalidListenerException.cpython-312.pyc b/MumbleServer/__pycache__/InvalidListenerException.cpython-312.pyc new file mode 100644 index 0000000..a57584d Binary files /dev/null and b/MumbleServer/__pycache__/InvalidListenerException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/InvalidSecretException.cpython-312.pyc b/MumbleServer/__pycache__/InvalidSecretException.cpython-312.pyc new file mode 100644 index 0000000..e5c60ee Binary files /dev/null and b/MumbleServer/__pycache__/InvalidSecretException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/InvalidServerException.cpython-312.pyc b/MumbleServer/__pycache__/InvalidServerException.cpython-312.pyc new file mode 100644 index 0000000..fa03822 Binary files /dev/null and b/MumbleServer/__pycache__/InvalidServerException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/InvalidSessionException.cpython-312.pyc b/MumbleServer/__pycache__/InvalidSessionException.cpython-312.pyc new file mode 100644 index 0000000..31d147e Binary files /dev/null and b/MumbleServer/__pycache__/InvalidSessionException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/InvalidTextureException.cpython-312.pyc b/MumbleServer/__pycache__/InvalidTextureException.cpython-312.pyc new file mode 100644 index 0000000..314f93c Binary files /dev/null and b/MumbleServer/__pycache__/InvalidTextureException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/InvalidUserException.cpython-312.pyc b/MumbleServer/__pycache__/InvalidUserException.cpython-312.pyc new file mode 100644 index 0000000..8cd69f6 Binary files /dev/null and b/MumbleServer/__pycache__/InvalidUserException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/LogEntry.cpython-312.pyc b/MumbleServer/__pycache__/LogEntry.cpython-312.pyc new file mode 100644 index 0000000..4acfcce Binary files /dev/null and b/MumbleServer/__pycache__/LogEntry.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/LogList.cpython-312.pyc b/MumbleServer/__pycache__/LogList.cpython-312.pyc new file mode 100644 index 0000000..5d5eea8 Binary files /dev/null and b/MumbleServer/__pycache__/LogList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/Meta.cpython-312.pyc b/MumbleServer/__pycache__/Meta.cpython-312.pyc new file mode 100644 index 0000000..d5a7554 Binary files /dev/null and b/MumbleServer/__pycache__/Meta.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/MetaCallback.cpython-312.pyc b/MumbleServer/__pycache__/MetaCallback.cpython-312.pyc new file mode 100644 index 0000000..199da54 Binary files /dev/null and b/MumbleServer/__pycache__/MetaCallback.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/MetaCallback_forward.cpython-312.pyc b/MumbleServer/__pycache__/MetaCallback_forward.cpython-312.pyc new file mode 100644 index 0000000..340895d Binary files /dev/null and b/MumbleServer/__pycache__/MetaCallback_forward.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/Meta_forward.cpython-312.pyc b/MumbleServer/__pycache__/Meta_forward.cpython-312.pyc new file mode 100644 index 0000000..3192831 Binary files /dev/null and b/MumbleServer/__pycache__/Meta_forward.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/NameList.cpython-312.pyc b/MumbleServer/__pycache__/NameList.cpython-312.pyc new file mode 100644 index 0000000..a1a40bb Binary files /dev/null and b/MumbleServer/__pycache__/NameList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/NameMap.cpython-312.pyc b/MumbleServer/__pycache__/NameMap.cpython-312.pyc new file mode 100644 index 0000000..eadf2a4 Binary files /dev/null and b/MumbleServer/__pycache__/NameMap.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/NestingLimitException.cpython-312.pyc b/MumbleServer/__pycache__/NestingLimitException.cpython-312.pyc new file mode 100644 index 0000000..6769eba Binary files /dev/null and b/MumbleServer/__pycache__/NestingLimitException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/NetAddress.cpython-312.pyc b/MumbleServer/__pycache__/NetAddress.cpython-312.pyc new file mode 100644 index 0000000..6999b75 Binary files /dev/null and b/MumbleServer/__pycache__/NetAddress.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionBan.cpython-312.pyc b/MumbleServer/__pycache__/PermissionBan.cpython-312.pyc new file mode 100644 index 0000000..c7b3529 Binary files /dev/null and b/MumbleServer/__pycache__/PermissionBan.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionEnter.cpython-312.pyc b/MumbleServer/__pycache__/PermissionEnter.cpython-312.pyc new file mode 100644 index 0000000..dd655bb Binary files /dev/null and b/MumbleServer/__pycache__/PermissionEnter.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionKick.cpython-312.pyc b/MumbleServer/__pycache__/PermissionKick.cpython-312.pyc new file mode 100644 index 0000000..bb92e95 Binary files /dev/null and b/MumbleServer/__pycache__/PermissionKick.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionLinkChannel.cpython-312.pyc b/MumbleServer/__pycache__/PermissionLinkChannel.cpython-312.pyc new file mode 100644 index 0000000..5f60fcb Binary files /dev/null and b/MumbleServer/__pycache__/PermissionLinkChannel.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionMakeChannel.cpython-312.pyc b/MumbleServer/__pycache__/PermissionMakeChannel.cpython-312.pyc new file mode 100644 index 0000000..5a8cf14 Binary files /dev/null and b/MumbleServer/__pycache__/PermissionMakeChannel.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionMakeTempChannel.cpython-312.pyc b/MumbleServer/__pycache__/PermissionMakeTempChannel.cpython-312.pyc new file mode 100644 index 0000000..059a4dd Binary files /dev/null and b/MumbleServer/__pycache__/PermissionMakeTempChannel.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionMove.cpython-312.pyc b/MumbleServer/__pycache__/PermissionMove.cpython-312.pyc new file mode 100644 index 0000000..978dfc6 Binary files /dev/null and b/MumbleServer/__pycache__/PermissionMove.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionMuteDeafen.cpython-312.pyc b/MumbleServer/__pycache__/PermissionMuteDeafen.cpython-312.pyc new file mode 100644 index 0000000..f40b4e2 Binary files /dev/null and b/MumbleServer/__pycache__/PermissionMuteDeafen.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionRegister.cpython-312.pyc b/MumbleServer/__pycache__/PermissionRegister.cpython-312.pyc new file mode 100644 index 0000000..59eb8ee Binary files /dev/null and b/MumbleServer/__pycache__/PermissionRegister.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionRegisterSelf.cpython-312.pyc b/MumbleServer/__pycache__/PermissionRegisterSelf.cpython-312.pyc new file mode 100644 index 0000000..9046b1e Binary files /dev/null and b/MumbleServer/__pycache__/PermissionRegisterSelf.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionSpeak.cpython-312.pyc b/MumbleServer/__pycache__/PermissionSpeak.cpython-312.pyc new file mode 100644 index 0000000..171824e Binary files /dev/null and b/MumbleServer/__pycache__/PermissionSpeak.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionTextMessage.cpython-312.pyc b/MumbleServer/__pycache__/PermissionTextMessage.cpython-312.pyc new file mode 100644 index 0000000..618988d Binary files /dev/null and b/MumbleServer/__pycache__/PermissionTextMessage.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionTraverse.cpython-312.pyc b/MumbleServer/__pycache__/PermissionTraverse.cpython-312.pyc new file mode 100644 index 0000000..f731a1b Binary files /dev/null and b/MumbleServer/__pycache__/PermissionTraverse.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionWhisper.cpython-312.pyc b/MumbleServer/__pycache__/PermissionWhisper.cpython-312.pyc new file mode 100644 index 0000000..99c73b9 Binary files /dev/null and b/MumbleServer/__pycache__/PermissionWhisper.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/PermissionWrite.cpython-312.pyc b/MumbleServer/__pycache__/PermissionWrite.cpython-312.pyc new file mode 100644 index 0000000..2bcd728 Binary files /dev/null and b/MumbleServer/__pycache__/PermissionWrite.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ReadOnlyModeException.cpython-312.pyc b/MumbleServer/__pycache__/ReadOnlyModeException.cpython-312.pyc new file mode 100644 index 0000000..59db7df Binary files /dev/null and b/MumbleServer/__pycache__/ReadOnlyModeException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ResetUserContent.cpython-312.pyc b/MumbleServer/__pycache__/ResetUserContent.cpython-312.pyc new file mode 100644 index 0000000..056d39b Binary files /dev/null and b/MumbleServer/__pycache__/ResetUserContent.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/Server.cpython-312.pyc b/MumbleServer/__pycache__/Server.cpython-312.pyc new file mode 100644 index 0000000..e7153c8 Binary files /dev/null and b/MumbleServer/__pycache__/Server.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerAuthenticator.cpython-312.pyc b/MumbleServer/__pycache__/ServerAuthenticator.cpython-312.pyc new file mode 100644 index 0000000..161a9c8 Binary files /dev/null and b/MumbleServer/__pycache__/ServerAuthenticator.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerAuthenticator_forward.cpython-312.pyc b/MumbleServer/__pycache__/ServerAuthenticator_forward.cpython-312.pyc new file mode 100644 index 0000000..d2e880a Binary files /dev/null and b/MumbleServer/__pycache__/ServerAuthenticator_forward.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerBootedException.cpython-312.pyc b/MumbleServer/__pycache__/ServerBootedException.cpython-312.pyc new file mode 100644 index 0000000..d8277d9 Binary files /dev/null and b/MumbleServer/__pycache__/ServerBootedException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerCallback.cpython-312.pyc b/MumbleServer/__pycache__/ServerCallback.cpython-312.pyc new file mode 100644 index 0000000..d6f870b Binary files /dev/null and b/MumbleServer/__pycache__/ServerCallback.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerCallback_forward.cpython-312.pyc b/MumbleServer/__pycache__/ServerCallback_forward.cpython-312.pyc new file mode 100644 index 0000000..a12885a Binary files /dev/null and b/MumbleServer/__pycache__/ServerCallback_forward.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerContextCallback.cpython-312.pyc b/MumbleServer/__pycache__/ServerContextCallback.cpython-312.pyc new file mode 100644 index 0000000..47071a7 Binary files /dev/null and b/MumbleServer/__pycache__/ServerContextCallback.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerContextCallback_forward.cpython-312.pyc b/MumbleServer/__pycache__/ServerContextCallback_forward.cpython-312.pyc new file mode 100644 index 0000000..843c79b Binary files /dev/null and b/MumbleServer/__pycache__/ServerContextCallback_forward.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerException.cpython-312.pyc b/MumbleServer/__pycache__/ServerException.cpython-312.pyc new file mode 100644 index 0000000..bc1af5e Binary files /dev/null and b/MumbleServer/__pycache__/ServerException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerFailureException.cpython-312.pyc b/MumbleServer/__pycache__/ServerFailureException.cpython-312.pyc new file mode 100644 index 0000000..8c077ee Binary files /dev/null and b/MumbleServer/__pycache__/ServerFailureException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerList.cpython-312.pyc b/MumbleServer/__pycache__/ServerList.cpython-312.pyc new file mode 100644 index 0000000..3693a3d Binary files /dev/null and b/MumbleServer/__pycache__/ServerList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerUpdatingAuthenticator.cpython-312.pyc b/MumbleServer/__pycache__/ServerUpdatingAuthenticator.cpython-312.pyc new file mode 100644 index 0000000..94fe50a Binary files /dev/null and b/MumbleServer/__pycache__/ServerUpdatingAuthenticator.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/ServerUpdatingAuthenticator_forward.cpython-312.pyc b/MumbleServer/__pycache__/ServerUpdatingAuthenticator_forward.cpython-312.pyc new file mode 100644 index 0000000..5310b9e Binary files /dev/null and b/MumbleServer/__pycache__/ServerUpdatingAuthenticator_forward.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/Server_forward.cpython-312.pyc b/MumbleServer/__pycache__/Server_forward.cpython-312.pyc new file mode 100644 index 0000000..ae9fdfe Binary files /dev/null and b/MumbleServer/__pycache__/Server_forward.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/TextMessage.cpython-312.pyc b/MumbleServer/__pycache__/TextMessage.cpython-312.pyc new file mode 100644 index 0000000..5659352 Binary files /dev/null and b/MumbleServer/__pycache__/TextMessage.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/Texture.cpython-312.pyc b/MumbleServer/__pycache__/Texture.cpython-312.pyc new file mode 100644 index 0000000..2a11c6c Binary files /dev/null and b/MumbleServer/__pycache__/Texture.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/Tree.cpython-312.pyc b/MumbleServer/__pycache__/Tree.cpython-312.pyc new file mode 100644 index 0000000..8ca982a Binary files /dev/null and b/MumbleServer/__pycache__/Tree.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/TreeList.cpython-312.pyc b/MumbleServer/__pycache__/TreeList.cpython-312.pyc new file mode 100644 index 0000000..8442ac6 Binary files /dev/null and b/MumbleServer/__pycache__/TreeList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/Tree_forward.cpython-312.pyc b/MumbleServer/__pycache__/Tree_forward.cpython-312.pyc new file mode 100644 index 0000000..0fc4678 Binary files /dev/null and b/MumbleServer/__pycache__/Tree_forward.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/User.cpython-312.pyc b/MumbleServer/__pycache__/User.cpython-312.pyc new file mode 100644 index 0000000..7557884 Binary files /dev/null and b/MumbleServer/__pycache__/User.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/UserInfo.cpython-312.pyc b/MumbleServer/__pycache__/UserInfo.cpython-312.pyc new file mode 100644 index 0000000..a893e0d Binary files /dev/null and b/MumbleServer/__pycache__/UserInfo.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/UserInfoMap.cpython-312.pyc b/MumbleServer/__pycache__/UserInfoMap.cpython-312.pyc new file mode 100644 index 0000000..60e41fd Binary files /dev/null and b/MumbleServer/__pycache__/UserInfoMap.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/UserList.cpython-312.pyc b/MumbleServer/__pycache__/UserList.cpython-312.pyc new file mode 100644 index 0000000..cfed1ae Binary files /dev/null and b/MumbleServer/__pycache__/UserList.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/UserMap.cpython-312.pyc b/MumbleServer/__pycache__/UserMap.cpython-312.pyc new file mode 100644 index 0000000..9223405 Binary files /dev/null and b/MumbleServer/__pycache__/UserMap.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/WriteOnlyException.cpython-312.pyc b/MumbleServer/__pycache__/WriteOnlyException.cpython-312.pyc new file mode 100644 index 0000000..10b3a6c Binary files /dev/null and b/MumbleServer/__pycache__/WriteOnlyException.cpython-312.pyc differ diff --git a/MumbleServer/__pycache__/__init__.cpython-312.pyc b/MumbleServer/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000..1066f39 Binary files /dev/null and b/MumbleServer/__pycache__/__init__.cpython-312.pyc differ diff --git a/MumbleServer_ice.py b/MumbleServer_ice.py new file mode 100644 index 0000000..df900a4 --- /dev/null +++ b/MumbleServer_ice.py @@ -0,0 +1,6804 @@ +# -*- coding: utf-8 -*- +# +# Copyright (c) ZeroC, Inc. All rights reserved. +# +# +# Ice version 3.7.10 +# +# +# +# Generated from file `MumbleServer.ice' +# +# Warning: do not edit this file. +# +# +# + +from sys import version_info as _version_info_ +import Ice, IcePy +import Ice.SliceChecksumDict_ice + +# Included module Ice +_M_Ice = Ice.openModule('Ice') + +# Start of module MumbleServer +_M_MumbleServer = Ice.openModule('MumbleServer') +__name__ = 'MumbleServer' + +if '_t_NetAddress' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_NetAddress = IcePy.defineSequence('::MumbleServer::NetAddress', ('python:seq:tuple',), IcePy._t_byte) + +if 'User' not in _M_MumbleServer.__dict__: + _M_MumbleServer.User = Ice.createTempClass() + class User(object): + """ + A connected user. + Members: + session -- Session ID. This identifies the connection to the server. + userid -- User ID. -1 if the user is anonymous. + mute -- Is user muted by the server? + deaf -- Is user deafened by the server? If true, this implies mute. + suppress -- Is the user suppressed by the server? This means the user is not muted, but does not have speech privileges in the current channel. + prioritySpeaker -- Is the user a priority speaker? + selfMute -- Is the user self-muted? + selfDeaf -- Is the user self-deafened? If true, this implies mute. + recording -- Is the User recording? (This flag is read-only and cannot be changed using setState().) + channel -- Channel ID the user is in. Matches Channel.id. + name -- The name of the user. + onlinesecs -- Seconds user has been online. + bytespersec -- Average transmission rate in bytes per second over the last few seconds. + version -- Legacy client version. + version2 -- New client version. (See https://github.com/mumble-voip/mumble/issues/5827) + release -- Client release. For official releases, this equals the version. For snapshots and git compiles, this will be something else. + os -- Client OS. + osversion -- Client OS Version. + identity -- Plugin Identity. This will be the user's unique ID inside the current game. + context -- Base64-encoded Plugin context. This is a binary blob identifying the game and team the user is on. + The used Base64 alphabet is the one specified in RFC 2045. + Before Mumble 1.3.0, this string was not Base64-encoded. This could cause problems for some Ice + implementations, such as the .NET implementation. + If you need the exact string that is used by Mumble, you can get it by Base64-decoding this string. + If you simply need to detect whether two users are in the same game world, string comparisons will + continue to work as before. + comment -- User comment. Shown as tooltip for this user. + address -- Client address. + tcponly -- TCP only. True until UDP connectivity is established. + idlesecs -- Idle time. This is how many seconds it is since the user last spoke. Other activity is not counted. + udpPing -- UDP Ping Average. This is the average ping for the user via UDP over the duration of the connection. + tcpPing -- TCP Ping Average. This is the average ping for the user via TCP over the duration of the connection. + """ + def __init__(self, session=0, userid=0, mute=False, deaf=False, suppress=False, prioritySpeaker=False, selfMute=False, selfDeaf=False, recording=False, channel=0, name='', onlinesecs=0, bytespersec=0, version=0, version2=0, release='', os='', osversion='', identity='', context='', comment='', address=None, tcponly=False, idlesecs=0, udpPing=0.0, tcpPing=0.0): + self.session = session + self.userid = userid + self.mute = mute + self.deaf = deaf + self.suppress = suppress + self.prioritySpeaker = prioritySpeaker + self.selfMute = selfMute + self.selfDeaf = selfDeaf + self.recording = recording + self.channel = channel + self.name = name + self.onlinesecs = onlinesecs + self.bytespersec = bytespersec + self.version = version + self.version2 = version2 + self.release = release + self.os = os + self.osversion = osversion + self.identity = identity + self.context = context + self.comment = comment + self.address = address + self.tcponly = tcponly + self.idlesecs = idlesecs + self.udpPing = udpPing + self.tcpPing = tcpPing + + def __eq__(self, other): + if other is None: + return False + elif not isinstance(other, _M_MumbleServer.User): + return NotImplemented + else: + if self.session != other.session: + return False + if self.userid != other.userid: + return False + if self.mute != other.mute: + return False + if self.deaf != other.deaf: + return False + if self.suppress != other.suppress: + return False + if self.prioritySpeaker != other.prioritySpeaker: + return False + if self.selfMute != other.selfMute: + return False + if self.selfDeaf != other.selfDeaf: + return False + if self.recording != other.recording: + return False + if self.channel != other.channel: + return False + if self.name != other.name: + return False + if self.onlinesecs != other.onlinesecs: + return False + if self.bytespersec != other.bytespersec: + return False + if self.version != other.version: + return False + if self.version2 != other.version2: + return False + if self.release != other.release: + return False + if self.os != other.os: + return False + if self.osversion != other.osversion: + return False + if self.identity != other.identity: + return False + if self.context != other.context: + return False + if self.comment != other.comment: + return False + if self.address != other.address: + return False + if self.tcponly != other.tcponly: + return False + if self.idlesecs != other.idlesecs: + return False + if self.udpPing != other.udpPing: + return False + if self.tcpPing != other.tcpPing: + return False + return True + + def __ne__(self, other): + return not self.__eq__(other) + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_User) + + __repr__ = __str__ + + _M_MumbleServer._t_User = IcePy.defineStruct('::MumbleServer::User', User, (), ( + ('session', (), IcePy._t_int), + ('userid', (), IcePy._t_int), + ('mute', (), IcePy._t_bool), + ('deaf', (), IcePy._t_bool), + ('suppress', (), IcePy._t_bool), + ('prioritySpeaker', (), IcePy._t_bool), + ('selfMute', (), IcePy._t_bool), + ('selfDeaf', (), IcePy._t_bool), + ('recording', (), IcePy._t_bool), + ('channel', (), IcePy._t_int), + ('name', (), IcePy._t_string), + ('onlinesecs', (), IcePy._t_int), + ('bytespersec', (), IcePy._t_int), + ('version', (), IcePy._t_int), + ('version2', (), IcePy._t_long), + ('release', (), IcePy._t_string), + ('os', (), IcePy._t_string), + ('osversion', (), IcePy._t_string), + ('identity', (), IcePy._t_string), + ('context', (), IcePy._t_string), + ('comment', (), IcePy._t_string), + ('address', (), _M_MumbleServer._t_NetAddress), + ('tcponly', (), IcePy._t_bool), + ('idlesecs', (), IcePy._t_int), + ('udpPing', (), IcePy._t_float), + ('tcpPing', (), IcePy._t_float) + )) + + _M_MumbleServer.User = User + del User + +if '_t_IntList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_IntList = IcePy.defineSequence('::MumbleServer::IntList', (), IcePy._t_int) + +if 'TextMessage' not in _M_MumbleServer.__dict__: + _M_MumbleServer.TextMessage = Ice.createTempClass() + class TextMessage(object): + """ + A text message between users. + Members: + sessions -- Sessions (connected users) who were sent this message. + channels -- Channels who were sent this message. + trees -- Trees of channels who were sent this message. + text -- The contents of the message. + """ + def __init__(self, sessions=None, channels=None, trees=None, text=''): + self.sessions = sessions + self.channels = channels + self.trees = trees + self.text = text + + def __hash__(self): + _h = 0 + if self.sessions: + for _i0 in self.sessions: + _h = 5 * _h + Ice.getHash(_i0) + if self.channels: + for _i1 in self.channels: + _h = 5 * _h + Ice.getHash(_i1) + if self.trees: + for _i2 in self.trees: + _h = 5 * _h + Ice.getHash(_i2) + _h = 5 * _h + Ice.getHash(self.text) + return _h % 0x7fffffff + + def __compare(self, other): + if other is None: + return 1 + elif not isinstance(other, _M_MumbleServer.TextMessage): + return NotImplemented + else: + if self.sessions is None or other.sessions is None: + if self.sessions != other.sessions: + return (-1 if self.sessions is None else 1) + else: + if self.sessions < other.sessions: + return -1 + elif self.sessions > other.sessions: + return 1 + if self.channels is None or other.channels is None: + if self.channels != other.channels: + return (-1 if self.channels is None else 1) + else: + if self.channels < other.channels: + return -1 + elif self.channels > other.channels: + return 1 + if self.trees is None or other.trees is None: + if self.trees != other.trees: + return (-1 if self.trees is None else 1) + else: + if self.trees < other.trees: + return -1 + elif self.trees > other.trees: + return 1 + if self.text is None or other.text is None: + if self.text != other.text: + return (-1 if self.text is None else 1) + else: + if self.text < other.text: + return -1 + elif self.text > other.text: + return 1 + return 0 + + def __lt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r < 0 + + def __le__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r <= 0 + + def __gt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r > 0 + + def __ge__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r >= 0 + + def __eq__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r == 0 + + def __ne__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r != 0 + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_TextMessage) + + __repr__ = __str__ + + _M_MumbleServer._t_TextMessage = IcePy.defineStruct('::MumbleServer::TextMessage', TextMessage, (), ( + ('sessions', (), _M_MumbleServer._t_IntList), + ('channels', (), _M_MumbleServer._t_IntList), + ('trees', (), _M_MumbleServer._t_IntList), + ('text', (), IcePy._t_string) + )) + + _M_MumbleServer.TextMessage = TextMessage + del TextMessage + +if 'Channel' not in _M_MumbleServer.__dict__: + _M_MumbleServer.Channel = Ice.createTempClass() + class Channel(object): + """ + A channel. + Members: + id -- Channel ID. This is unique per channel, and the root channel is always id 0. + name -- Name of the channel. There can not be two channels with the same parent that has the same name. + parent -- ID of parent channel, or -1 if this is the root channel. + links -- List of id of linked channels. + description -- Description of channel. Shown as tooltip for this channel. + temporary -- Channel is temporary, and will be removed when the last user leaves it. + position -- Position of the channel which is used in Client for sorting. + """ + def __init__(self, id=0, name='', parent=0, links=None, description='', temporary=False, position=0): + self.id = id + self.name = name + self.parent = parent + self.links = links + self.description = description + self.temporary = temporary + self.position = position + + def __hash__(self): + _h = 0 + _h = 5 * _h + Ice.getHash(self.id) + _h = 5 * _h + Ice.getHash(self.name) + _h = 5 * _h + Ice.getHash(self.parent) + if self.links: + for _i0 in self.links: + _h = 5 * _h + Ice.getHash(_i0) + _h = 5 * _h + Ice.getHash(self.description) + _h = 5 * _h + Ice.getHash(self.temporary) + _h = 5 * _h + Ice.getHash(self.position) + return _h % 0x7fffffff + + def __compare(self, other): + if other is None: + return 1 + elif not isinstance(other, _M_MumbleServer.Channel): + return NotImplemented + else: + if self.id is None or other.id is None: + if self.id != other.id: + return (-1 if self.id is None else 1) + else: + if self.id < other.id: + return -1 + elif self.id > other.id: + return 1 + if self.name is None or other.name is None: + if self.name != other.name: + return (-1 if self.name is None else 1) + else: + if self.name < other.name: + return -1 + elif self.name > other.name: + return 1 + if self.parent is None or other.parent is None: + if self.parent != other.parent: + return (-1 if self.parent is None else 1) + else: + if self.parent < other.parent: + return -1 + elif self.parent > other.parent: + return 1 + if self.links is None or other.links is None: + if self.links != other.links: + return (-1 if self.links is None else 1) + else: + if self.links < other.links: + return -1 + elif self.links > other.links: + return 1 + if self.description is None or other.description is None: + if self.description != other.description: + return (-1 if self.description is None else 1) + else: + if self.description < other.description: + return -1 + elif self.description > other.description: + return 1 + if self.temporary is None or other.temporary is None: + if self.temporary != other.temporary: + return (-1 if self.temporary is None else 1) + else: + if self.temporary < other.temporary: + return -1 + elif self.temporary > other.temporary: + return 1 + if self.position is None or other.position is None: + if self.position != other.position: + return (-1 if self.position is None else 1) + else: + if self.position < other.position: + return -1 + elif self.position > other.position: + return 1 + return 0 + + def __lt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r < 0 + + def __le__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r <= 0 + + def __gt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r > 0 + + def __ge__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r >= 0 + + def __eq__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r == 0 + + def __ne__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r != 0 + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_Channel) + + __repr__ = __str__ + + _M_MumbleServer._t_Channel = IcePy.defineStruct('::MumbleServer::Channel', Channel, (), ( + ('id', (), IcePy._t_int), + ('name', (), IcePy._t_string), + ('parent', (), IcePy._t_int), + ('links', (), _M_MumbleServer._t_IntList), + ('description', (), IcePy._t_string), + ('temporary', (), IcePy._t_bool), + ('position', (), IcePy._t_int) + )) + + _M_MumbleServer.Channel = Channel + del Channel + +if 'Group' not in _M_MumbleServer.__dict__: + _M_MumbleServer.Group = Ice.createTempClass() + class Group(object): + """ + A group. Groups are defined per channel, and can inherit members from parent channels. + Members: + name -- Group name + inherited -- Is this group inherited from a parent channel? Read-only. + inherit -- Does this group inherit members from parent channels? + inheritable -- Can subchannels inherit members from this group? + add -- List of users to add to the group. + remove -- List of inherited users to remove from the group. + members -- Current members of the group, including inherited members. Read-only. + """ + def __init__(self, name='', inherited=False, inherit=False, inheritable=False, add=None, remove=None, members=None): + self.name = name + self.inherited = inherited + self.inherit = inherit + self.inheritable = inheritable + self.add = add + self.remove = remove + self.members = members + + def __hash__(self): + _h = 0 + _h = 5 * _h + Ice.getHash(self.name) + _h = 5 * _h + Ice.getHash(self.inherited) + _h = 5 * _h + Ice.getHash(self.inherit) + _h = 5 * _h + Ice.getHash(self.inheritable) + if self.add: + for _i0 in self.add: + _h = 5 * _h + Ice.getHash(_i0) + if self.remove: + for _i1 in self.remove: + _h = 5 * _h + Ice.getHash(_i1) + if self.members: + for _i2 in self.members: + _h = 5 * _h + Ice.getHash(_i2) + return _h % 0x7fffffff + + def __compare(self, other): + if other is None: + return 1 + elif not isinstance(other, _M_MumbleServer.Group): + return NotImplemented + else: + if self.name is None or other.name is None: + if self.name != other.name: + return (-1 if self.name is None else 1) + else: + if self.name < other.name: + return -1 + elif self.name > other.name: + return 1 + if self.inherited is None or other.inherited is None: + if self.inherited != other.inherited: + return (-1 if self.inherited is None else 1) + else: + if self.inherited < other.inherited: + return -1 + elif self.inherited > other.inherited: + return 1 + if self.inherit is None or other.inherit is None: + if self.inherit != other.inherit: + return (-1 if self.inherit is None else 1) + else: + if self.inherit < other.inherit: + return -1 + elif self.inherit > other.inherit: + return 1 + if self.inheritable is None or other.inheritable is None: + if self.inheritable != other.inheritable: + return (-1 if self.inheritable is None else 1) + else: + if self.inheritable < other.inheritable: + return -1 + elif self.inheritable > other.inheritable: + return 1 + if self.add is None or other.add is None: + if self.add != other.add: + return (-1 if self.add is None else 1) + else: + if self.add < other.add: + return -1 + elif self.add > other.add: + return 1 + if self.remove is None or other.remove is None: + if self.remove != other.remove: + return (-1 if self.remove is None else 1) + else: + if self.remove < other.remove: + return -1 + elif self.remove > other.remove: + return 1 + if self.members is None or other.members is None: + if self.members != other.members: + return (-1 if self.members is None else 1) + else: + if self.members < other.members: + return -1 + elif self.members > other.members: + return 1 + return 0 + + def __lt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r < 0 + + def __le__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r <= 0 + + def __gt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r > 0 + + def __ge__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r >= 0 + + def __eq__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r == 0 + + def __ne__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r != 0 + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_Group) + + __repr__ = __str__ + + _M_MumbleServer._t_Group = IcePy.defineStruct('::MumbleServer::Group', Group, (), ( + ('name', (), IcePy._t_string), + ('inherited', (), IcePy._t_bool), + ('inherit', (), IcePy._t_bool), + ('inheritable', (), IcePy._t_bool), + ('add', (), _M_MumbleServer._t_IntList), + ('remove', (), _M_MumbleServer._t_IntList), + ('members', (), _M_MumbleServer._t_IntList) + )) + + _M_MumbleServer.Group = Group + del Group + +_M_MumbleServer.PermissionWrite = 1 + +_M_MumbleServer.PermissionTraverse = 2 + +_M_MumbleServer.PermissionEnter = 4 + +_M_MumbleServer.PermissionSpeak = 8 + +_M_MumbleServer.PermissionWhisper = 256 + +_M_MumbleServer.PermissionMuteDeafen = 16 + +_M_MumbleServer.PermissionMove = 32 + +_M_MumbleServer.PermissionMakeChannel = 64 + +_M_MumbleServer.PermissionMakeTempChannel = 1024 + +_M_MumbleServer.PermissionLinkChannel = 128 + +_M_MumbleServer.PermissionTextMessage = 512 + +_M_MumbleServer.PermissionKick = 65536 + +_M_MumbleServer.PermissionBan = 131072 + +_M_MumbleServer.PermissionRegister = 262144 + +_M_MumbleServer.PermissionRegisterSelf = 524288 + +_M_MumbleServer.ResetUserContent = 1048576 + +if 'ACL' not in _M_MumbleServer.__dict__: + _M_MumbleServer.ACL = Ice.createTempClass() + class ACL(object): + """ + Access Control List for a channel. ACLs are defined per channel, and can be inherited from parent channels. + Members: + applyHere -- Does the ACL apply to this channel? + applySubs -- Does the ACL apply to subchannels? + inherited -- Is this ACL inherited from a parent channel? Read-only. + userid -- ID of user this ACL applies to. -1 if using a group name. + group -- Group this ACL applies to. Blank if using userid. + allow -- Binary mask of privileges to allow. + deny -- Binary mask of privileges to deny. + """ + def __init__(self, applyHere=False, applySubs=False, inherited=False, userid=0, group='', allow=0, deny=0): + self.applyHere = applyHere + self.applySubs = applySubs + self.inherited = inherited + self.userid = userid + self.group = group + self.allow = allow + self.deny = deny + + def __hash__(self): + _h = 0 + _h = 5 * _h + Ice.getHash(self.applyHere) + _h = 5 * _h + Ice.getHash(self.applySubs) + _h = 5 * _h + Ice.getHash(self.inherited) + _h = 5 * _h + Ice.getHash(self.userid) + _h = 5 * _h + Ice.getHash(self.group) + _h = 5 * _h + Ice.getHash(self.allow) + _h = 5 * _h + Ice.getHash(self.deny) + return _h % 0x7fffffff + + def __compare(self, other): + if other is None: + return 1 + elif not isinstance(other, _M_MumbleServer.ACL): + return NotImplemented + else: + if self.applyHere is None or other.applyHere is None: + if self.applyHere != other.applyHere: + return (-1 if self.applyHere is None else 1) + else: + if self.applyHere < other.applyHere: + return -1 + elif self.applyHere > other.applyHere: + return 1 + if self.applySubs is None or other.applySubs is None: + if self.applySubs != other.applySubs: + return (-1 if self.applySubs is None else 1) + else: + if self.applySubs < other.applySubs: + return -1 + elif self.applySubs > other.applySubs: + return 1 + if self.inherited is None or other.inherited is None: + if self.inherited != other.inherited: + return (-1 if self.inherited is None else 1) + else: + if self.inherited < other.inherited: + return -1 + elif self.inherited > other.inherited: + return 1 + if self.userid is None or other.userid is None: + if self.userid != other.userid: + return (-1 if self.userid is None else 1) + else: + if self.userid < other.userid: + return -1 + elif self.userid > other.userid: + return 1 + if self.group is None or other.group is None: + if self.group != other.group: + return (-1 if self.group is None else 1) + else: + if self.group < other.group: + return -1 + elif self.group > other.group: + return 1 + if self.allow is None or other.allow is None: + if self.allow != other.allow: + return (-1 if self.allow is None else 1) + else: + if self.allow < other.allow: + return -1 + elif self.allow > other.allow: + return 1 + if self.deny is None or other.deny is None: + if self.deny != other.deny: + return (-1 if self.deny is None else 1) + else: + if self.deny < other.deny: + return -1 + elif self.deny > other.deny: + return 1 + return 0 + + def __lt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r < 0 + + def __le__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r <= 0 + + def __gt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r > 0 + + def __ge__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r >= 0 + + def __eq__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r == 0 + + def __ne__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r != 0 + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_ACL) + + __repr__ = __str__ + + _M_MumbleServer._t_ACL = IcePy.defineStruct('::MumbleServer::ACL', ACL, (), ( + ('applyHere', (), IcePy._t_bool), + ('applySubs', (), IcePy._t_bool), + ('inherited', (), IcePy._t_bool), + ('userid', (), IcePy._t_int), + ('group', (), IcePy._t_string), + ('allow', (), IcePy._t_int), + ('deny', (), IcePy._t_int) + )) + + _M_MumbleServer.ACL = ACL + del ACL + +if 'Ban' not in _M_MumbleServer.__dict__: + _M_MumbleServer.Ban = Ice.createTempClass() + class Ban(object): + """ + A single ip mask for a ban. + Members: + address -- Address to ban. + bits -- Number of bits in ban to apply. + name -- Username associated with ban. + hash -- Hash of banned user. + reason -- Reason for ban. + start -- Date ban was applied in unix time format. + duration -- Duration of ban. + """ + def __init__(self, address=None, bits=0, name='', hash='', reason='', start=0, duration=0): + self.address = address + self.bits = bits + self.name = name + self.hash = hash + self.reason = reason + self.start = start + self.duration = duration + + def __hash__(self): + _h = 0 + if self.address: + for _i0 in self.address: + _h = 5 * _h + Ice.getHash(_i0) + _h = 5 * _h + Ice.getHash(self.bits) + _h = 5 * _h + Ice.getHash(self.name) + _h = 5 * _h + Ice.getHash(self.hash) + _h = 5 * _h + Ice.getHash(self.reason) + _h = 5 * _h + Ice.getHash(self.start) + _h = 5 * _h + Ice.getHash(self.duration) + return _h % 0x7fffffff + + def __compare(self, other): + if other is None: + return 1 + elif not isinstance(other, _M_MumbleServer.Ban): + return NotImplemented + else: + if self.address is None or other.address is None: + if self.address != other.address: + return (-1 if self.address is None else 1) + else: + if self.address < other.address: + return -1 + elif self.address > other.address: + return 1 + if self.bits is None or other.bits is None: + if self.bits != other.bits: + return (-1 if self.bits is None else 1) + else: + if self.bits < other.bits: + return -1 + elif self.bits > other.bits: + return 1 + if self.name is None or other.name is None: + if self.name != other.name: + return (-1 if self.name is None else 1) + else: + if self.name < other.name: + return -1 + elif self.name > other.name: + return 1 + if self.hash is None or other.hash is None: + if self.hash != other.hash: + return (-1 if self.hash is None else 1) + else: + if self.hash < other.hash: + return -1 + elif self.hash > other.hash: + return 1 + if self.reason is None or other.reason is None: + if self.reason != other.reason: + return (-1 if self.reason is None else 1) + else: + if self.reason < other.reason: + return -1 + elif self.reason > other.reason: + return 1 + if self.start is None or other.start is None: + if self.start != other.start: + return (-1 if self.start is None else 1) + else: + if self.start < other.start: + return -1 + elif self.start > other.start: + return 1 + if self.duration is None or other.duration is None: + if self.duration != other.duration: + return (-1 if self.duration is None else 1) + else: + if self.duration < other.duration: + return -1 + elif self.duration > other.duration: + return 1 + return 0 + + def __lt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r < 0 + + def __le__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r <= 0 + + def __gt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r > 0 + + def __ge__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r >= 0 + + def __eq__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r == 0 + + def __ne__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r != 0 + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_Ban) + + __repr__ = __str__ + + _M_MumbleServer._t_Ban = IcePy.defineStruct('::MumbleServer::Ban', Ban, (), ( + ('address', (), _M_MumbleServer._t_NetAddress), + ('bits', (), IcePy._t_int), + ('name', (), IcePy._t_string), + ('hash', (), IcePy._t_string), + ('reason', (), IcePy._t_string), + ('start', (), IcePy._t_int), + ('duration', (), IcePy._t_int) + )) + + _M_MumbleServer.Ban = Ban + del Ban + +if 'LogEntry' not in _M_MumbleServer.__dict__: + _M_MumbleServer.LogEntry = Ice.createTempClass() + class LogEntry(object): + """ + A entry in the log. + Members: + timestamp -- Timestamp in UNIX time_t + txt -- The log message. + """ + def __init__(self, timestamp=0, txt=''): + self.timestamp = timestamp + self.txt = txt + + def __hash__(self): + _h = 0 + _h = 5 * _h + Ice.getHash(self.timestamp) + _h = 5 * _h + Ice.getHash(self.txt) + return _h % 0x7fffffff + + def __compare(self, other): + if other is None: + return 1 + elif not isinstance(other, _M_MumbleServer.LogEntry): + return NotImplemented + else: + if self.timestamp is None or other.timestamp is None: + if self.timestamp != other.timestamp: + return (-1 if self.timestamp is None else 1) + else: + if self.timestamp < other.timestamp: + return -1 + elif self.timestamp > other.timestamp: + return 1 + if self.txt is None or other.txt is None: + if self.txt != other.txt: + return (-1 if self.txt is None else 1) + else: + if self.txt < other.txt: + return -1 + elif self.txt > other.txt: + return 1 + return 0 + + def __lt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r < 0 + + def __le__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r <= 0 + + def __gt__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r > 0 + + def __ge__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r >= 0 + + def __eq__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r == 0 + + def __ne__(self, other): + r = self.__compare(other) + if r is NotImplemented: + return r + else: + return r != 0 + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_LogEntry) + + __repr__ = __str__ + + _M_MumbleServer._t_LogEntry = IcePy.defineStruct('::MumbleServer::LogEntry', LogEntry, (), ( + ('timestamp', (), IcePy._t_int), + ('txt', (), IcePy._t_string) + )) + + _M_MumbleServer.LogEntry = LogEntry + del LogEntry + +if 'Tree' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_Tree = IcePy.declareValue('::MumbleServer::Tree') + +if '_t_TreeList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_TreeList = IcePy.defineSequence('::MumbleServer::TreeList', (), _M_MumbleServer._t_Tree) + +if 'ChannelInfo' not in _M_MumbleServer.__dict__: + _M_MumbleServer.ChannelInfo = Ice.createTempClass() + class ChannelInfo(Ice.EnumBase): + + def __init__(self, _n, _v): + Ice.EnumBase.__init__(self, _n, _v) + + def valueOf(self, _n): + if _n in self._enumerators: + return self._enumerators[_n] + return None + valueOf = classmethod(valueOf) + + ChannelInfo.ChannelDescription = ChannelInfo("ChannelDescription", 0) + ChannelInfo.ChannelPosition = ChannelInfo("ChannelPosition", 1) + ChannelInfo._enumerators = { 0:ChannelInfo.ChannelDescription, 1:ChannelInfo.ChannelPosition } + + _M_MumbleServer._t_ChannelInfo = IcePy.defineEnum('::MumbleServer::ChannelInfo', ChannelInfo, (), ChannelInfo._enumerators) + + _M_MumbleServer.ChannelInfo = ChannelInfo + del ChannelInfo + +if 'UserInfo' not in _M_MumbleServer.__dict__: + _M_MumbleServer.UserInfo = Ice.createTempClass() + class UserInfo(Ice.EnumBase): + + def __init__(self, _n, _v): + Ice.EnumBase.__init__(self, _n, _v) + + def valueOf(self, _n): + if _n in self._enumerators: + return self._enumerators[_n] + return None + valueOf = classmethod(valueOf) + + UserInfo.UserName = UserInfo("UserName", 0) + UserInfo.UserEmail = UserInfo("UserEmail", 1) + UserInfo.UserComment = UserInfo("UserComment", 2) + UserInfo.UserHash = UserInfo("UserHash", 3) + UserInfo.UserPassword = UserInfo("UserPassword", 4) + UserInfo.UserLastActive = UserInfo("UserLastActive", 5) + UserInfo.UserKDFIterations = UserInfo("UserKDFIterations", 6) + UserInfo._enumerators = { 0:UserInfo.UserName, 1:UserInfo.UserEmail, 2:UserInfo.UserComment, 3:UserInfo.UserHash, 4:UserInfo.UserPassword, 5:UserInfo.UserLastActive, 6:UserInfo.UserKDFIterations } + + _M_MumbleServer._t_UserInfo = IcePy.defineEnum('::MumbleServer::UserInfo', UserInfo, (), UserInfo._enumerators) + + _M_MumbleServer.UserInfo = UserInfo + del UserInfo + +if '_t_UserMap' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_UserMap = IcePy.defineDictionary('::MumbleServer::UserMap', (), IcePy._t_int, _M_MumbleServer._t_User) + +if '_t_ChannelMap' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_ChannelMap = IcePy.defineDictionary('::MumbleServer::ChannelMap', (), IcePy._t_int, _M_MumbleServer._t_Channel) + +if '_t_ChannelList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_ChannelList = IcePy.defineSequence('::MumbleServer::ChannelList', (), _M_MumbleServer._t_Channel) + +if '_t_UserList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_UserList = IcePy.defineSequence('::MumbleServer::UserList', (), _M_MumbleServer._t_User) + +if '_t_GroupList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_GroupList = IcePy.defineSequence('::MumbleServer::GroupList', (), _M_MumbleServer._t_Group) + +if '_t_ACLList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_ACLList = IcePy.defineSequence('::MumbleServer::ACLList', (), _M_MumbleServer._t_ACL) + +if '_t_LogList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_LogList = IcePy.defineSequence('::MumbleServer::LogList', (), _M_MumbleServer._t_LogEntry) + +if '_t_BanList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_BanList = IcePy.defineSequence('::MumbleServer::BanList', (), _M_MumbleServer._t_Ban) + +if '_t_IdList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_IdList = IcePy.defineSequence('::MumbleServer::IdList', (), IcePy._t_int) + +if '_t_NameList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_NameList = IcePy.defineSequence('::MumbleServer::NameList', (), IcePy._t_string) + +if '_t_NameMap' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_NameMap = IcePy.defineDictionary('::MumbleServer::NameMap', (), IcePy._t_int, IcePy._t_string) + +if '_t_IdMap' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_IdMap = IcePy.defineDictionary('::MumbleServer::IdMap', (), IcePy._t_string, IcePy._t_int) + +if '_t_Texture' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_Texture = IcePy.defineSequence('::MumbleServer::Texture', (), IcePy._t_byte) + +if '_t_ConfigMap' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_ConfigMap = IcePy.defineDictionary('::MumbleServer::ConfigMap', (), IcePy._t_string, IcePy._t_string) + +if '_t_GroupNameList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_GroupNameList = IcePy.defineSequence('::MumbleServer::GroupNameList', (), IcePy._t_string) + +if '_t_CertificateDer' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_CertificateDer = IcePy.defineSequence('::MumbleServer::CertificateDer', (), IcePy._t_byte) + +if '_t_CertificateList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_CertificateList = IcePy.defineSequence('::MumbleServer::CertificateList', (), _M_MumbleServer._t_CertificateDer) + +if '_t_UserInfoMap' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_UserInfoMap = IcePy.defineDictionary('::MumbleServer::UserInfoMap', (), _M_MumbleServer._t_UserInfo, IcePy._t_string) + +if 'Tree' not in _M_MumbleServer.__dict__: + _M_MumbleServer.Tree = Ice.createTempClass() + class Tree(Ice.Value): + """ + User and subchannel state. Read-only. + Members: + c -- Channel definition of current channel. + children -- List of subchannels. + users -- Users in this channel. + """ + def __init__(self, c=Ice._struct_marker, children=None, users=None): + if c is Ice._struct_marker: + self.c = _M_MumbleServer.Channel() + else: + self.c = c + self.children = children + self.users = users + + def ice_id(self): + return '::MumbleServer::Tree' + + @staticmethod + def ice_staticId(): + return '::MumbleServer::Tree' + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_Tree) + + __repr__ = __str__ + + _M_MumbleServer._t_Tree = IcePy.defineValue('::MumbleServer::Tree', Tree, -1, (), False, False, None, ( + ('c', (), _M_MumbleServer._t_Channel, False, 0), + ('children', (), _M_MumbleServer._t_TreeList, False, 0), + ('users', (), _M_MumbleServer._t_UserList, False, 0) + )) + Tree._ice_type = _M_MumbleServer._t_Tree + + _M_MumbleServer.Tree = Tree + del Tree + +if 'MurmurException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.MurmurException = Ice.createTempClass() + class MurmurException(Ice.UserException): + def __init__(self): + pass + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::MurmurException' + + _M_MumbleServer._t_MurmurException = IcePy.defineException('::MumbleServer::MurmurException', MurmurException, (), False, None, ()) + MurmurException._ice_type = _M_MumbleServer._t_MurmurException + + _M_MumbleServer.MurmurException = MurmurException + del MurmurException + +if 'InvalidSessionException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.InvalidSessionException = Ice.createTempClass() + class InvalidSessionException(_M_MumbleServer.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 + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::InvalidSessionException' + + _M_MumbleServer._t_InvalidSessionException = IcePy.defineException('::MumbleServer::InvalidSessionException', InvalidSessionException, (), False, _M_MumbleServer._t_MurmurException, ()) + InvalidSessionException._ice_type = _M_MumbleServer._t_InvalidSessionException + + _M_MumbleServer.InvalidSessionException = InvalidSessionException + del InvalidSessionException + +if 'InvalidChannelException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.InvalidChannelException = Ice.createTempClass() + class InvalidChannelException(_M_MumbleServer.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. + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::InvalidChannelException' + + _M_MumbleServer._t_InvalidChannelException = IcePy.defineException('::MumbleServer::InvalidChannelException', InvalidChannelException, (), False, _M_MumbleServer._t_MurmurException, ()) + InvalidChannelException._ice_type = _M_MumbleServer._t_InvalidChannelException + + _M_MumbleServer.InvalidChannelException = InvalidChannelException + del InvalidChannelException + +if 'InvalidServerException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.InvalidServerException = Ice.createTempClass() + class InvalidServerException(_M_MumbleServer.MurmurException): + """ + This is thrown when you try to do an operation on a server that does not exist. This may happen if someone has removed the server. + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::InvalidServerException' + + _M_MumbleServer._t_InvalidServerException = IcePy.defineException('::MumbleServer::InvalidServerException', InvalidServerException, (), False, _M_MumbleServer._t_MurmurException, ()) + InvalidServerException._ice_type = _M_MumbleServer._t_InvalidServerException + + _M_MumbleServer.InvalidServerException = InvalidServerException + del InvalidServerException + +if 'ServerBootedException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.ServerBootedException = Ice.createTempClass() + class ServerBootedException(_M_MumbleServer.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. + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::ServerBootedException' + + _M_MumbleServer._t_ServerBootedException = IcePy.defineException('::MumbleServer::ServerBootedException', ServerBootedException, (), False, _M_MumbleServer._t_MurmurException, ()) + ServerBootedException._ice_type = _M_MumbleServer._t_ServerBootedException + + _M_MumbleServer.ServerBootedException = ServerBootedException + del ServerBootedException + +if 'ServerFailureException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.ServerFailureException = Ice.createTempClass() + class ServerFailureException(_M_MumbleServer.MurmurException): + """ + This is thrown if Server.start fails, and should generally be the cause for some concern. + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::ServerFailureException' + + _M_MumbleServer._t_ServerFailureException = IcePy.defineException('::MumbleServer::ServerFailureException', ServerFailureException, (), False, _M_MumbleServer._t_MurmurException, ()) + ServerFailureException._ice_type = _M_MumbleServer._t_ServerFailureException + + _M_MumbleServer.ServerFailureException = ServerFailureException + del ServerFailureException + +if 'InvalidUserException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.InvalidUserException = Ice.createTempClass() + class InvalidUserException(_M_MumbleServer.MurmurException): + """ + This is thrown when you specify an invalid userid. + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::InvalidUserException' + + _M_MumbleServer._t_InvalidUserException = IcePy.defineException('::MumbleServer::InvalidUserException', InvalidUserException, (), False, _M_MumbleServer._t_MurmurException, ()) + InvalidUserException._ice_type = _M_MumbleServer._t_InvalidUserException + + _M_MumbleServer.InvalidUserException = InvalidUserException + del InvalidUserException + +if 'InvalidTextureException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.InvalidTextureException = Ice.createTempClass() + class InvalidTextureException(_M_MumbleServer.MurmurException): + """ + This is thrown when you try to set an invalid texture. + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::InvalidTextureException' + + _M_MumbleServer._t_InvalidTextureException = IcePy.defineException('::MumbleServer::InvalidTextureException', InvalidTextureException, (), False, _M_MumbleServer._t_MurmurException, ()) + InvalidTextureException._ice_type = _M_MumbleServer._t_InvalidTextureException + + _M_MumbleServer.InvalidTextureException = InvalidTextureException + del InvalidTextureException + +if 'InvalidCallbackException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.InvalidCallbackException = Ice.createTempClass() + class InvalidCallbackException(_M_MumbleServer.MurmurException): + """ + This is thrown when you supply an invalid callback. + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::InvalidCallbackException' + + _M_MumbleServer._t_InvalidCallbackException = IcePy.defineException('::MumbleServer::InvalidCallbackException', InvalidCallbackException, (), False, _M_MumbleServer._t_MurmurException, ()) + InvalidCallbackException._ice_type = _M_MumbleServer._t_InvalidCallbackException + + _M_MumbleServer.InvalidCallbackException = InvalidCallbackException + del InvalidCallbackException + +if 'InvalidSecretException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.InvalidSecretException = Ice.createTempClass() + class InvalidSecretException(_M_MumbleServer.MurmurException): + """ + This is thrown when you supply the wrong secret in the calling context. + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::InvalidSecretException' + + _M_MumbleServer._t_InvalidSecretException = IcePy.defineException('::MumbleServer::InvalidSecretException', InvalidSecretException, (), False, _M_MumbleServer._t_MurmurException, ()) + InvalidSecretException._ice_type = _M_MumbleServer._t_InvalidSecretException + + _M_MumbleServer.InvalidSecretException = InvalidSecretException + del InvalidSecretException + +if 'NestingLimitException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.NestingLimitException = Ice.createTempClass() + class NestingLimitException(_M_MumbleServer.MurmurException): + """ + This is thrown when the channel operation would exceed the channel nesting limit + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::NestingLimitException' + + _M_MumbleServer._t_NestingLimitException = IcePy.defineException('::MumbleServer::NestingLimitException', NestingLimitException, (), False, _M_MumbleServer._t_MurmurException, ()) + NestingLimitException._ice_type = _M_MumbleServer._t_NestingLimitException + + _M_MumbleServer.NestingLimitException = NestingLimitException + del NestingLimitException + +if 'WriteOnlyException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.WriteOnlyException = Ice.createTempClass() + class WriteOnlyException(_M_MumbleServer.MurmurException): + """ + This is thrown when you ask the server to disclose something that should be secret. + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::WriteOnlyException' + + _M_MumbleServer._t_WriteOnlyException = IcePy.defineException('::MumbleServer::WriteOnlyException', WriteOnlyException, (), False, _M_MumbleServer._t_MurmurException, ()) + WriteOnlyException._ice_type = _M_MumbleServer._t_WriteOnlyException + + _M_MumbleServer.WriteOnlyException = WriteOnlyException + del WriteOnlyException + +if 'InvalidInputDataException' not in _M_MumbleServer.__dict__: + _M_MumbleServer.InvalidInputDataException = Ice.createTempClass() + class InvalidInputDataException(_M_MumbleServer.MurmurException): + """ + This is thrown when invalid input data was specified. + """ + def __init__(self): + _M_MumbleServer.MurmurException.__init__(self) + + def __str__(self): + return IcePy.stringifyException(self) + + __repr__ = __str__ + + _ice_id = '::MumbleServer::InvalidInputDataException' + + _M_MumbleServer._t_InvalidInputDataException = IcePy.defineException('::MumbleServer::InvalidInputDataException', InvalidInputDataException, (), False, _M_MumbleServer._t_MurmurException, ()) + InvalidInputDataException._ice_type = _M_MumbleServer._t_InvalidInputDataException + + _M_MumbleServer.InvalidInputDataException = InvalidInputDataException + del InvalidInputDataException + +_M_MumbleServer._t_ServerCallback = IcePy.defineValue('::MumbleServer::ServerCallback', Ice.Value, -1, (), False, True, None, ()) + +if 'ServerCallbackPrx' not in _M_MumbleServer.__dict__: + _M_MumbleServer.ServerCallbackPrx = Ice.createTempClass() + class ServerCallbackPrx(Ice.ObjectPrx): + + """ + Called when a user connects to the server. + Arguments: + state -- State of connected user. + context -- The request context for the invocation. + """ + def userConnected(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_userConnected.invoke(self, ((state, ), context)) + + """ + Called when a user connects to the server. + Arguments: + state -- State of connected user. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def userConnectedAsync(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_userConnected.invokeAsync(self, ((state, ), context)) + + """ + Called when a user connects to the server. + Arguments: + state -- State of connected user. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_userConnected(self, state, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerCallback._op_userConnected.begin(self, ((state, ), _response, _ex, _sent, context)) + + """ + Called when a user connects to the server. + Arguments: + state -- State of connected user. + """ + def end_userConnected(self, _r): + return _M_MumbleServer.ServerCallback._op_userConnected.end(self, _r) + + """ + Called when a user disconnects from the server. The user has already been removed, so you can no longer use methods like Server.getState + to retrieve the user's state. + Arguments: + state -- State of disconnected user. + context -- The request context for the invocation. + """ + def userDisconnected(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_userDisconnected.invoke(self, ((state, ), context)) + + """ + Called when a user disconnects from the server. The user has already been removed, so you can no longer use methods like Server.getState + to retrieve the user's state. + Arguments: + state -- State of disconnected user. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def userDisconnectedAsync(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_userDisconnected.invokeAsync(self, ((state, ), context)) + + """ + Called when a user disconnects from the server. The user has already been removed, so you can no longer use methods like Server.getState + to retrieve the user's state. + Arguments: + state -- State of disconnected user. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_userDisconnected(self, state, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerCallback._op_userDisconnected.begin(self, ((state, ), _response, _ex, _sent, context)) + + """ + Called when a user disconnects from the server. The user has already been removed, so you can no longer use methods like Server.getState + to retrieve the user's state. + Arguments: + state -- State of disconnected user. + """ + def end_userDisconnected(self, _r): + return _M_MumbleServer.ServerCallback._op_userDisconnected.end(self, _r) + + """ + Called when a user state changes. This is called if the user moves, is renamed, is muted, deafened etc. + Arguments: + state -- New state of user. + context -- The request context for the invocation. + """ + def userStateChanged(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_userStateChanged.invoke(self, ((state, ), context)) + + """ + Called when a user state changes. This is called if the user moves, is renamed, is muted, deafened etc. + Arguments: + state -- New state of user. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def userStateChangedAsync(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_userStateChanged.invokeAsync(self, ((state, ), context)) + + """ + Called when a user state changes. This is called if the user moves, is renamed, is muted, deafened etc. + Arguments: + state -- New state of user. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_userStateChanged(self, state, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerCallback._op_userStateChanged.begin(self, ((state, ), _response, _ex, _sent, context)) + + """ + Called when a user state changes. This is called if the user moves, is renamed, is muted, deafened etc. + Arguments: + state -- New state of user. + """ + def end_userStateChanged(self, _r): + return _M_MumbleServer.ServerCallback._op_userStateChanged.end(self, _r) + + """ + Called when user writes a text message + Arguments: + state -- the User sending the message + message -- the TextMessage the user has sent + context -- The request context for the invocation. + """ + def userTextMessage(self, state, message, context=None): + return _M_MumbleServer.ServerCallback._op_userTextMessage.invoke(self, ((state, message), context)) + + """ + Called when user writes a text message + Arguments: + state -- the User sending the message + message -- the TextMessage the user has sent + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def userTextMessageAsync(self, state, message, context=None): + return _M_MumbleServer.ServerCallback._op_userTextMessage.invokeAsync(self, ((state, message), context)) + + """ + Called when user writes a text message + Arguments: + state -- the User sending the message + message -- the TextMessage the user has sent + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_userTextMessage(self, state, message, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerCallback._op_userTextMessage.begin(self, ((state, message), _response, _ex, _sent, context)) + + """ + Called when user writes a text message + Arguments: + state -- the User sending the message + message -- the TextMessage the user has sent + """ + def end_userTextMessage(self, _r): + return _M_MumbleServer.ServerCallback._op_userTextMessage.end(self, _r) + + """ + Called when a new channel is created. + Arguments: + state -- State of new channel. + context -- The request context for the invocation. + """ + def channelCreated(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_channelCreated.invoke(self, ((state, ), context)) + + """ + Called when a new channel is created. + Arguments: + state -- State of new channel. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def channelCreatedAsync(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_channelCreated.invokeAsync(self, ((state, ), context)) + + """ + Called when a new channel is created. + Arguments: + state -- State of new channel. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_channelCreated(self, state, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerCallback._op_channelCreated.begin(self, ((state, ), _response, _ex, _sent, context)) + + """ + Called when a new channel is created. + Arguments: + state -- State of new channel. + """ + def end_channelCreated(self, _r): + return _M_MumbleServer.ServerCallback._op_channelCreated.end(self, _r) + + """ + Called when a channel is removed. The channel has already been removed, you can no longer use methods like Server.getChannelState + Arguments: + state -- State of removed channel. + context -- The request context for the invocation. + """ + def channelRemoved(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_channelRemoved.invoke(self, ((state, ), context)) + + """ + Called when a channel is removed. The channel has already been removed, you can no longer use methods like Server.getChannelState + Arguments: + state -- State of removed channel. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def channelRemovedAsync(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_channelRemoved.invokeAsync(self, ((state, ), context)) + + """ + Called when a channel is removed. The channel has already been removed, you can no longer use methods like Server.getChannelState + Arguments: + state -- State of removed channel. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_channelRemoved(self, state, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerCallback._op_channelRemoved.begin(self, ((state, ), _response, _ex, _sent, context)) + + """ + Called when a channel is removed. The channel has already been removed, you can no longer use methods like Server.getChannelState + Arguments: + state -- State of removed channel. + """ + def end_channelRemoved(self, _r): + return _M_MumbleServer.ServerCallback._op_channelRemoved.end(self, _r) + + """ + Called when a new channel state changes. This is called if the channel is moved, renamed or if new links are added. + Arguments: + state -- New state of channel. + context -- The request context for the invocation. + """ + def channelStateChanged(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_channelStateChanged.invoke(self, ((state, ), context)) + + """ + Called when a new channel state changes. This is called if the channel is moved, renamed or if new links are added. + Arguments: + state -- New state of channel. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def channelStateChangedAsync(self, state, context=None): + return _M_MumbleServer.ServerCallback._op_channelStateChanged.invokeAsync(self, ((state, ), context)) + + """ + Called when a new channel state changes. This is called if the channel is moved, renamed or if new links are added. + Arguments: + state -- New state of channel. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_channelStateChanged(self, state, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerCallback._op_channelStateChanged.begin(self, ((state, ), _response, _ex, _sent, context)) + + """ + Called when a new channel state changes. This is called if the channel is moved, renamed or if new links are added. + Arguments: + state -- New state of channel. + """ + def end_channelStateChanged(self, _r): + return _M_MumbleServer.ServerCallback._op_channelStateChanged.end(self, _r) + + @staticmethod + def checkedCast(proxy, facetOrContext=None, context=None): + return _M_MumbleServer.ServerCallbackPrx.ice_checkedCast(proxy, '::MumbleServer::ServerCallback', facetOrContext, context) + + @staticmethod + def uncheckedCast(proxy, facet=None): + return _M_MumbleServer.ServerCallbackPrx.ice_uncheckedCast(proxy, facet) + + @staticmethod + def ice_staticId(): + return '::MumbleServer::ServerCallback' + _M_MumbleServer._t_ServerCallbackPrx = IcePy.defineProxy('::MumbleServer::ServerCallback', ServerCallbackPrx) + + _M_MumbleServer.ServerCallbackPrx = ServerCallbackPrx + del ServerCallbackPrx + + _M_MumbleServer.ServerCallback = Ice.createTempClass() + class ServerCallback(Ice.Object): + + def ice_ids(self, current=None): + return ('::Ice::Object', '::MumbleServer::ServerCallback') + + def ice_id(self, current=None): + return '::MumbleServer::ServerCallback' + + @staticmethod + def ice_staticId(): + return '::MumbleServer::ServerCallback' + + def userConnected(self, state, current=None): + """ + Called when a user connects to the server. + Arguments: + state -- State of connected user. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'userConnected' not implemented") + + def userDisconnected(self, state, current=None): + """ + Called when a user disconnects from the server. The user has already been removed, so you can no longer use methods like Server.getState + to retrieve the user's state. + Arguments: + state -- State of disconnected user. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'userDisconnected' not implemented") + + def userStateChanged(self, state, current=None): + """ + Called when a user state changes. This is called if the user moves, is renamed, is muted, deafened etc. + Arguments: + state -- New state of user. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'userStateChanged' not implemented") + + def userTextMessage(self, state, message, current=None): + """ + Called when user writes a text message + Arguments: + state -- the User sending the message + message -- the TextMessage the user has sent + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'userTextMessage' not implemented") + + def channelCreated(self, state, current=None): + """ + Called when a new channel is created. + Arguments: + state -- State of new channel. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'channelCreated' not implemented") + + def channelRemoved(self, state, current=None): + """ + Called when a channel is removed. The channel has already been removed, you can no longer use methods like Server.getChannelState + Arguments: + state -- State of removed channel. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'channelRemoved' not implemented") + + def channelStateChanged(self, state, current=None): + """ + Called when a new channel state changes. This is called if the channel is moved, renamed or if new links are added. + Arguments: + state -- New state of channel. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'channelStateChanged' not implemented") + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_ServerCallbackDisp) + + __repr__ = __str__ + + _M_MumbleServer._t_ServerCallbackDisp = IcePy.defineClass('::MumbleServer::ServerCallback', ServerCallback, (), None, ()) + ServerCallback._ice_type = _M_MumbleServer._t_ServerCallbackDisp + + ServerCallback._op_userConnected = IcePy.Operation('userConnected', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), _M_MumbleServer._t_User, False, 0),), (), None, ()) + ServerCallback._op_userDisconnected = IcePy.Operation('userDisconnected', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), _M_MumbleServer._t_User, False, 0),), (), None, ()) + ServerCallback._op_userStateChanged = IcePy.Operation('userStateChanged', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), _M_MumbleServer._t_User, False, 0),), (), None, ()) + ServerCallback._op_userTextMessage = IcePy.Operation('userTextMessage', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), _M_MumbleServer._t_User, False, 0), ((), _M_MumbleServer._t_TextMessage, False, 0)), (), None, ()) + ServerCallback._op_channelCreated = IcePy.Operation('channelCreated', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), _M_MumbleServer._t_Channel, False, 0),), (), None, ()) + ServerCallback._op_channelRemoved = IcePy.Operation('channelRemoved', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), _M_MumbleServer._t_Channel, False, 0),), (), None, ()) + ServerCallback._op_channelStateChanged = IcePy.Operation('channelStateChanged', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), _M_MumbleServer._t_Channel, False, 0),), (), None, ()) + + _M_MumbleServer.ServerCallback = ServerCallback + del ServerCallback + +_M_MumbleServer.ContextServer = 1 + +_M_MumbleServer.ContextChannel = 2 + +_M_MumbleServer.ContextUser = 4 + +_M_MumbleServer._t_ServerContextCallback = IcePy.defineValue('::MumbleServer::ServerContextCallback', Ice.Value, -1, (), False, True, None, ()) + +if 'ServerContextCallbackPrx' not in _M_MumbleServer.__dict__: + _M_MumbleServer.ServerContextCallbackPrx = Ice.createTempClass() + class ServerContextCallbackPrx(Ice.ObjectPrx): + + """ + Called when a context action is performed. + Arguments: + action -- Action to be performed. + usr -- User which initiated the action. + session -- If nonzero, session of target user. + channelid -- If not -1, id of target channel. + context -- The request context for the invocation. + """ + def contextAction(self, action, usr, session, channelid, context=None): + return _M_MumbleServer.ServerContextCallback._op_contextAction.invoke(self, ((action, usr, session, channelid), context)) + + """ + Called when a context action is performed. + Arguments: + action -- Action to be performed. + usr -- User which initiated the action. + session -- If nonzero, session of target user. + channelid -- If not -1, id of target channel. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def contextActionAsync(self, action, usr, session, channelid, context=None): + return _M_MumbleServer.ServerContextCallback._op_contextAction.invokeAsync(self, ((action, usr, session, channelid), context)) + + """ + Called when a context action is performed. + Arguments: + action -- Action to be performed. + usr -- User which initiated the action. + session -- If nonzero, session of target user. + channelid -- If not -1, id of target channel. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_contextAction(self, action, usr, session, channelid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerContextCallback._op_contextAction.begin(self, ((action, usr, session, channelid), _response, _ex, _sent, context)) + + """ + Called when a context action is performed. + Arguments: + action -- Action to be performed. + usr -- User which initiated the action. + session -- If nonzero, session of target user. + channelid -- If not -1, id of target channel. + """ + def end_contextAction(self, _r): + return _M_MumbleServer.ServerContextCallback._op_contextAction.end(self, _r) + + @staticmethod + def checkedCast(proxy, facetOrContext=None, context=None): + return _M_MumbleServer.ServerContextCallbackPrx.ice_checkedCast(proxy, '::MumbleServer::ServerContextCallback', facetOrContext, context) + + @staticmethod + def uncheckedCast(proxy, facet=None): + return _M_MumbleServer.ServerContextCallbackPrx.ice_uncheckedCast(proxy, facet) + + @staticmethod + def ice_staticId(): + return '::MumbleServer::ServerContextCallback' + _M_MumbleServer._t_ServerContextCallbackPrx = IcePy.defineProxy('::MumbleServer::ServerContextCallback', ServerContextCallbackPrx) + + _M_MumbleServer.ServerContextCallbackPrx = ServerContextCallbackPrx + del ServerContextCallbackPrx + + _M_MumbleServer.ServerContextCallback = Ice.createTempClass() + class ServerContextCallback(Ice.Object): + + def ice_ids(self, current=None): + return ('::Ice::Object', '::MumbleServer::ServerContextCallback') + + def ice_id(self, current=None): + return '::MumbleServer::ServerContextCallback' + + @staticmethod + def ice_staticId(): + return '::MumbleServer::ServerContextCallback' + + def contextAction(self, action, usr, session, channelid, current=None): + """ + Called when a context action is performed. + Arguments: + action -- Action to be performed. + usr -- User which initiated the action. + session -- If nonzero, session of target user. + channelid -- If not -1, id of target channel. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'contextAction' not implemented") + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_ServerContextCallbackDisp) + + __repr__ = __str__ + + _M_MumbleServer._t_ServerContextCallbackDisp = IcePy.defineClass('::MumbleServer::ServerContextCallback', ServerContextCallback, (), None, ()) + ServerContextCallback._ice_type = _M_MumbleServer._t_ServerContextCallbackDisp + + ServerContextCallback._op_contextAction = IcePy.Operation('contextAction', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), IcePy._t_string, False, 0), ((), _M_MumbleServer._t_User, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), (), None, ()) + + _M_MumbleServer.ServerContextCallback = ServerContextCallback + del ServerContextCallback + +_M_MumbleServer._t_ServerAuthenticator = IcePy.defineValue('::MumbleServer::ServerAuthenticator', Ice.Value, -1, (), False, True, None, ()) + +if 'ServerAuthenticatorPrx' not in _M_MumbleServer.__dict__: + _M_MumbleServer.ServerAuthenticatorPrx = Ice.createTempClass() + class ServerAuthenticatorPrx(Ice.ObjectPrx): + + """ + Called to authenticate a user. If you do not know the username in question, always return -2 from this + method to fall through to normal database authentication. + Note that if authentication succeeds, murmur will create a record of the user in it's database, reserving + the username and id so it cannot be used for normal database authentication. + The data in the certificate (name, email addresses etc), as well as the list of signing certificates, + should only be trusted if certstrong is true. + Internally, Murmur treats usernames as case-insensitive. It is recommended + that authenticators do the same. Murmur checks if a username is in use when + a user connects. If the connecting user is registered, the other username is + kicked. If the connecting user is not registered, the connecting user is not + allowed to join the server. + Arguments: + name -- Username to authenticate. + pw -- Password to authenticate with. + certificates -- List of der encoded certificates the user connected with. + certhash -- Hash of user certificate, as used by murmur internally when matching. + certstrong -- True if certificate was valid and signed by a trusted CA. + context -- The request context for the invocation. + Returns a tuple containing the following: + _retval -- UserID of authenticated user, -1 for authentication failures, -2 for unknown user (fallthrough), -3 for authentication failures where the data could (temporarily) not be verified. + newname -- Set this to change the username from the supplied one. + groups -- List of groups on the root channel that the user will be added to for the duration of the connection. + """ + def authenticate(self, name, pw, certificates, certhash, certstrong, context=None): + return _M_MumbleServer.ServerAuthenticator._op_authenticate.invoke(self, ((name, pw, certificates, certhash, certstrong), context)) + + """ + Called to authenticate a user. If you do not know the username in question, always return -2 from this + method to fall through to normal database authentication. + Note that if authentication succeeds, murmur will create a record of the user in it's database, reserving + the username and id so it cannot be used for normal database authentication. + The data in the certificate (name, email addresses etc), as well as the list of signing certificates, + should only be trusted if certstrong is true. + Internally, Murmur treats usernames as case-insensitive. It is recommended + that authenticators do the same. Murmur checks if a username is in use when + a user connects. If the connecting user is registered, the other username is + kicked. If the connecting user is not registered, the connecting user is not + allowed to join the server. + Arguments: + name -- Username to authenticate. + pw -- Password to authenticate with. + certificates -- List of der encoded certificates the user connected with. + certhash -- Hash of user certificate, as used by murmur internally when matching. + certstrong -- True if certificate was valid and signed by a trusted CA. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def authenticateAsync(self, name, pw, certificates, certhash, certstrong, context=None): + return _M_MumbleServer.ServerAuthenticator._op_authenticate.invokeAsync(self, ((name, pw, certificates, certhash, certstrong), context)) + + """ + Called to authenticate a user. If you do not know the username in question, always return -2 from this + method to fall through to normal database authentication. + Note that if authentication succeeds, murmur will create a record of the user in it's database, reserving + the username and id so it cannot be used for normal database authentication. + The data in the certificate (name, email addresses etc), as well as the list of signing certificates, + should only be trusted if certstrong is true. + Internally, Murmur treats usernames as case-insensitive. It is recommended + that authenticators do the same. Murmur checks if a username is in use when + a user connects. If the connecting user is registered, the other username is + kicked. If the connecting user is not registered, the connecting user is not + allowed to join the server. + Arguments: + name -- Username to authenticate. + pw -- Password to authenticate with. + certificates -- List of der encoded certificates the user connected with. + certhash -- Hash of user certificate, as used by murmur internally when matching. + certstrong -- True if certificate was valid and signed by a trusted CA. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_authenticate(self, name, pw, certificates, certhash, certstrong, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerAuthenticator._op_authenticate.begin(self, ((name, pw, certificates, certhash, certstrong), _response, _ex, _sent, context)) + + """ + Called to authenticate a user. If you do not know the username in question, always return -2 from this + method to fall through to normal database authentication. + Note that if authentication succeeds, murmur will create a record of the user in it's database, reserving + the username and id so it cannot be used for normal database authentication. + The data in the certificate (name, email addresses etc), as well as the list of signing certificates, + should only be trusted if certstrong is true. + Internally, Murmur treats usernames as case-insensitive. It is recommended + that authenticators do the same. Murmur checks if a username is in use when + a user connects. If the connecting user is registered, the other username is + kicked. If the connecting user is not registered, the connecting user is not + allowed to join the server. + Arguments: + name -- Username to authenticate. + pw -- Password to authenticate with. + certificates -- List of der encoded certificates the user connected with. + certhash -- Hash of user certificate, as used by murmur internally when matching. + certstrong -- True if certificate was valid and signed by a trusted CA. + Returns a tuple containing the following: + _retval -- UserID of authenticated user, -1 for authentication failures, -2 for unknown user (fallthrough), -3 for authentication failures where the data could (temporarily) not be verified. + newname -- Set this to change the username from the supplied one. + groups -- List of groups on the root channel that the user will be added to for the duration of the connection. + """ + def end_authenticate(self, _r): + return _M_MumbleServer.ServerAuthenticator._op_authenticate.end(self, _r) + + """ + Fetch information about a user. This is used to retrieve information like email address, keyhash etc. If you + want murmur to take care of this information itself, simply return false to fall through. + Arguments: + id -- User id. + context -- The request context for the invocation. + Returns a tuple containing the following: + _retval -- true if information is present, false to fall through. + info -- Information about user. This needs to include at least "name". + """ + def getInfo(self, id, context=None): + return _M_MumbleServer.ServerAuthenticator._op_getInfo.invoke(self, ((id, ), context)) + + """ + Fetch information about a user. This is used to retrieve information like email address, keyhash etc. If you + want murmur to take care of this information itself, simply return false to fall through. + Arguments: + id -- User id. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getInfoAsync(self, id, context=None): + return _M_MumbleServer.ServerAuthenticator._op_getInfo.invokeAsync(self, ((id, ), context)) + + """ + Fetch information about a user. This is used to retrieve information like email address, keyhash etc. If you + want murmur to take care of this information itself, simply return false to fall through. + Arguments: + id -- User id. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getInfo(self, id, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerAuthenticator._op_getInfo.begin(self, ((id, ), _response, _ex, _sent, context)) + + """ + Fetch information about a user. This is used to retrieve information like email address, keyhash etc. If you + want murmur to take care of this information itself, simply return false to fall through. + Arguments: + id -- User id. + Returns a tuple containing the following: + _retval -- true if information is present, false to fall through. + info -- Information about user. This needs to include at least "name". + """ + def end_getInfo(self, _r): + return _M_MumbleServer.ServerAuthenticator._op_getInfo.end(self, _r) + + """ + Map a name to a user id. + Arguments: + name -- Username to map. + context -- The request context for the invocation. + Returns: User id or -2 for unknown name. + """ + def nameToId(self, name, context=None): + return _M_MumbleServer.ServerAuthenticator._op_nameToId.invoke(self, ((name, ), context)) + + """ + Map a name to a user id. + Arguments: + name -- Username to map. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def nameToIdAsync(self, name, context=None): + return _M_MumbleServer.ServerAuthenticator._op_nameToId.invokeAsync(self, ((name, ), context)) + + """ + Map a name to a user id. + Arguments: + name -- Username to map. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_nameToId(self, name, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerAuthenticator._op_nameToId.begin(self, ((name, ), _response, _ex, _sent, context)) + + """ + Map a name to a user id. + Arguments: + name -- Username to map. + Returns: User id or -2 for unknown name. + """ + def end_nameToId(self, _r): + return _M_MumbleServer.ServerAuthenticator._op_nameToId.end(self, _r) + + """ + Map a user id to a username. + Arguments: + id -- User id to map. + context -- The request context for the invocation. + Returns: Name of user or empty string for unknown id. + """ + def idToName(self, id, context=None): + return _M_MumbleServer.ServerAuthenticator._op_idToName.invoke(self, ((id, ), context)) + + """ + Map a user id to a username. + Arguments: + id -- User id to map. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def idToNameAsync(self, id, context=None): + return _M_MumbleServer.ServerAuthenticator._op_idToName.invokeAsync(self, ((id, ), context)) + + """ + Map a user id to a username. + Arguments: + id -- User id to map. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_idToName(self, id, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerAuthenticator._op_idToName.begin(self, ((id, ), _response, _ex, _sent, context)) + + """ + Map a user id to a username. + Arguments: + id -- User id to map. + Returns: Name of user or empty string for unknown id. + """ + def end_idToName(self, _r): + return _M_MumbleServer.ServerAuthenticator._op_idToName.end(self, _r) + + """ + Map a user to a custom Texture. + Arguments: + id -- User id to map. + context -- The request context for the invocation. + Returns: User texture or an empty texture for unknown users or users without textures. + """ + def idToTexture(self, id, context=None): + return _M_MumbleServer.ServerAuthenticator._op_idToTexture.invoke(self, ((id, ), context)) + + """ + Map a user to a custom Texture. + Arguments: + id -- User id to map. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def idToTextureAsync(self, id, context=None): + return _M_MumbleServer.ServerAuthenticator._op_idToTexture.invokeAsync(self, ((id, ), context)) + + """ + Map a user to a custom Texture. + Arguments: + id -- User id to map. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_idToTexture(self, id, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerAuthenticator._op_idToTexture.begin(self, ((id, ), _response, _ex, _sent, context)) + + """ + Map a user to a custom Texture. + Arguments: + id -- User id to map. + Returns: User texture or an empty texture for unknown users or users without textures. + """ + def end_idToTexture(self, _r): + return _M_MumbleServer.ServerAuthenticator._op_idToTexture.end(self, _r) + + @staticmethod + def checkedCast(proxy, facetOrContext=None, context=None): + return _M_MumbleServer.ServerAuthenticatorPrx.ice_checkedCast(proxy, '::MumbleServer::ServerAuthenticator', facetOrContext, context) + + @staticmethod + def uncheckedCast(proxy, facet=None): + return _M_MumbleServer.ServerAuthenticatorPrx.ice_uncheckedCast(proxy, facet) + + @staticmethod + def ice_staticId(): + return '::MumbleServer::ServerAuthenticator' + _M_MumbleServer._t_ServerAuthenticatorPrx = IcePy.defineProxy('::MumbleServer::ServerAuthenticator', ServerAuthenticatorPrx) + + _M_MumbleServer.ServerAuthenticatorPrx = ServerAuthenticatorPrx + del ServerAuthenticatorPrx + + _M_MumbleServer.ServerAuthenticator = Ice.createTempClass() + class ServerAuthenticator(Ice.Object): + + def ice_ids(self, current=None): + return ('::Ice::Object', '::MumbleServer::ServerAuthenticator') + + def ice_id(self, current=None): + return '::MumbleServer::ServerAuthenticator' + + @staticmethod + def ice_staticId(): + return '::MumbleServer::ServerAuthenticator' + + def authenticate(self, name, pw, certificates, certhash, certstrong, current=None): + """ + Called to authenticate a user. If you do not know the username in question, always return -2 from this + method to fall through to normal database authentication. + Note that if authentication succeeds, murmur will create a record of the user in it's database, reserving + the username and id so it cannot be used for normal database authentication. + The data in the certificate (name, email addresses etc), as well as the list of signing certificates, + should only be trusted if certstrong is true. + Internally, Murmur treats usernames as case-insensitive. It is recommended + that authenticators do the same. Murmur checks if a username is in use when + a user connects. If the connecting user is registered, the other username is + kicked. If the connecting user is not registered, the connecting user is not + allowed to join the server. + Arguments: + name -- Username to authenticate. + pw -- Password to authenticate with. + certificates -- List of der encoded certificates the user connected with. + certhash -- Hash of user certificate, as used by murmur internally when matching. + certstrong -- True if certificate was valid and signed by a trusted CA. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'authenticate' not implemented") + + def getInfo(self, id, current=None): + """ + Fetch information about a user. This is used to retrieve information like email address, keyhash etc. If you + want murmur to take care of this information itself, simply return false to fall through. + Arguments: + id -- User id. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getInfo' not implemented") + + def nameToId(self, name, current=None): + """ + Map a name to a user id. + Arguments: + name -- Username to map. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'nameToId' not implemented") + + def idToName(self, id, current=None): + """ + Map a user id to a username. + Arguments: + id -- User id to map. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'idToName' not implemented") + + def idToTexture(self, id, current=None): + """ + Map a user to a custom Texture. + Arguments: + id -- User id to map. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'idToTexture' not implemented") + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_ServerAuthenticatorDisp) + + __repr__ = __str__ + + _M_MumbleServer._t_ServerAuthenticatorDisp = IcePy.defineClass('::MumbleServer::ServerAuthenticator', ServerAuthenticator, (), None, ()) + ServerAuthenticator._ice_type = _M_MumbleServer._t_ServerAuthenticatorDisp + + ServerAuthenticator._op_authenticate = IcePy.Operation('authenticate', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0), ((), _M_MumbleServer._t_CertificateList, False, 0), ((), IcePy._t_string, False, 0), ((), IcePy._t_bool, False, 0)), (((), IcePy._t_string, False, 0), ((), _M_MumbleServer._t_GroupNameList, False, 0)), ((), IcePy._t_int, False, 0), ()) + ServerAuthenticator._op_getInfo = IcePy.Operation('getInfo', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), IcePy._t_int, False, 0),), (((), _M_MumbleServer._t_UserInfoMap, False, 0),), ((), IcePy._t_bool, False, 0), ()) + ServerAuthenticator._op_nameToId = IcePy.Operation('nameToId', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), IcePy._t_string, False, 0),), (), ((), IcePy._t_int, False, 0), ()) + ServerAuthenticator._op_idToName = IcePy.Operation('idToName', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), IcePy._t_int, False, 0),), (), ((), IcePy._t_string, False, 0), ()) + ServerAuthenticator._op_idToTexture = IcePy.Operation('idToTexture', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), IcePy._t_int, False, 0),), (), ((), _M_MumbleServer._t_Texture, False, 0), ()) + + _M_MumbleServer.ServerAuthenticator = ServerAuthenticator + del ServerAuthenticator + +_M_MumbleServer._t_ServerUpdatingAuthenticator = IcePy.defineValue('::MumbleServer::ServerUpdatingAuthenticator', Ice.Value, -1, (), False, True, None, ()) + +if 'ServerUpdatingAuthenticatorPrx' not in _M_MumbleServer.__dict__: + _M_MumbleServer.ServerUpdatingAuthenticatorPrx = Ice.createTempClass() + class ServerUpdatingAuthenticatorPrx(_M_MumbleServer.ServerAuthenticatorPrx): + + """ + Register a new user. + Arguments: + info -- Information about user to register. + context -- The request context for the invocation. + Returns: User id of new user, -1 for registration failure, or -2 to fall through. + """ + def registerUser(self, info, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_registerUser.invoke(self, ((info, ), context)) + + """ + Register a new user. + Arguments: + info -- Information about user to register. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def registerUserAsync(self, info, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_registerUser.invokeAsync(self, ((info, ), context)) + + """ + Register a new user. + Arguments: + info -- Information about user to register. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_registerUser(self, info, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_registerUser.begin(self, ((info, ), _response, _ex, _sent, context)) + + """ + Register a new user. + Arguments: + info -- Information about user to register. + Returns: User id of new user, -1 for registration failure, or -2 to fall through. + """ + def end_registerUser(self, _r): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_registerUser.end(self, _r) + + """ + Unregister a user. + Arguments: + id -- Userid to unregister. + context -- The request context for the invocation. + Returns: 1 for successful unregistration, 0 for unsuccessful unregistration, -1 to fall through. + """ + def unregisterUser(self, id, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_unregisterUser.invoke(self, ((id, ), context)) + + """ + Unregister a user. + Arguments: + id -- Userid to unregister. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def unregisterUserAsync(self, id, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_unregisterUser.invokeAsync(self, ((id, ), context)) + + """ + Unregister a user. + Arguments: + id -- Userid to unregister. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_unregisterUser(self, id, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_unregisterUser.begin(self, ((id, ), _response, _ex, _sent, context)) + + """ + Unregister a user. + Arguments: + id -- Userid to unregister. + Returns: 1 for successful unregistration, 0 for unsuccessful unregistration, -1 to fall through. + """ + def end_unregisterUser(self, _r): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_unregisterUser.end(self, _r) + + """ + Get a list of registered users matching filter. + Arguments: + filter -- Substring usernames must contain. If empty, return all registered users. + context -- The request context for the invocation. + Returns: List of matching registered users. + """ + def getRegisteredUsers(self, filter, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_getRegisteredUsers.invoke(self, ((filter, ), context)) + + """ + Get a list of registered users matching filter. + Arguments: + filter -- Substring usernames must contain. If empty, return all registered users. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getRegisteredUsersAsync(self, filter, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_getRegisteredUsers.invokeAsync(self, ((filter, ), context)) + + """ + Get a list of registered users matching filter. + Arguments: + filter -- Substring usernames must contain. If empty, return all registered users. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getRegisteredUsers(self, filter, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_getRegisteredUsers.begin(self, ((filter, ), _response, _ex, _sent, context)) + + """ + Get a list of registered users matching filter. + Arguments: + filter -- Substring usernames must contain. If empty, return all registered users. + Returns: List of matching registered users. + """ + def end_getRegisteredUsers(self, _r): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_getRegisteredUsers.end(self, _r) + + """ + Set additional information for user registration. + Arguments: + id -- Userid of registered user. + info -- Information to set about user. This should be merged with existing information. + context -- The request context for the invocation. + Returns: 1 for successful update, 0 for unsuccessful update, -1 to fall through. + """ + def setInfo(self, id, info, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_setInfo.invoke(self, ((id, info), context)) + + """ + Set additional information for user registration. + Arguments: + id -- Userid of registered user. + info -- Information to set about user. This should be merged with existing information. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def setInfoAsync(self, id, info, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_setInfo.invokeAsync(self, ((id, info), context)) + + """ + Set additional information for user registration. + Arguments: + id -- Userid of registered user. + info -- Information to set about user. This should be merged with existing information. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_setInfo(self, id, info, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_setInfo.begin(self, ((id, info), _response, _ex, _sent, context)) + + """ + Set additional information for user registration. + Arguments: + id -- Userid of registered user. + info -- Information to set about user. This should be merged with existing information. + Returns: 1 for successful update, 0 for unsuccessful update, -1 to fall through. + """ + def end_setInfo(self, _r): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_setInfo.end(self, _r) + + """ + Set texture (now called avatar) of user registration. + Arguments: + id -- registrationId of registered user. + tex -- New texture. + context -- The request context for the invocation. + Returns: 1 for successful update, 0 for unsuccessful update, -1 to fall through. + """ + def setTexture(self, id, tex, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_setTexture.invoke(self, ((id, tex), context)) + + """ + Set texture (now called avatar) of user registration. + Arguments: + id -- registrationId of registered user. + tex -- New texture. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def setTextureAsync(self, id, tex, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_setTexture.invokeAsync(self, ((id, tex), context)) + + """ + Set texture (now called avatar) of user registration. + Arguments: + id -- registrationId of registered user. + tex -- New texture. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_setTexture(self, id, tex, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_setTexture.begin(self, ((id, tex), _response, _ex, _sent, context)) + + """ + Set texture (now called avatar) of user registration. + Arguments: + id -- registrationId of registered user. + tex -- New texture. + Returns: 1 for successful update, 0 for unsuccessful update, -1 to fall through. + """ + def end_setTexture(self, _r): + return _M_MumbleServer.ServerUpdatingAuthenticator._op_setTexture.end(self, _r) + + @staticmethod + def checkedCast(proxy, facetOrContext=None, context=None): + return _M_MumbleServer.ServerUpdatingAuthenticatorPrx.ice_checkedCast(proxy, '::MumbleServer::ServerUpdatingAuthenticator', facetOrContext, context) + + @staticmethod + def uncheckedCast(proxy, facet=None): + return _M_MumbleServer.ServerUpdatingAuthenticatorPrx.ice_uncheckedCast(proxy, facet) + + @staticmethod + def ice_staticId(): + return '::MumbleServer::ServerUpdatingAuthenticator' + _M_MumbleServer._t_ServerUpdatingAuthenticatorPrx = IcePy.defineProxy('::MumbleServer::ServerUpdatingAuthenticator', ServerUpdatingAuthenticatorPrx) + + _M_MumbleServer.ServerUpdatingAuthenticatorPrx = ServerUpdatingAuthenticatorPrx + del ServerUpdatingAuthenticatorPrx + + _M_MumbleServer.ServerUpdatingAuthenticator = Ice.createTempClass() + class ServerUpdatingAuthenticator(_M_MumbleServer.ServerAuthenticator): + + def ice_ids(self, current=None): + return ('::Ice::Object', '::MumbleServer::ServerAuthenticator', '::MumbleServer::ServerUpdatingAuthenticator') + + def ice_id(self, current=None): + return '::MumbleServer::ServerUpdatingAuthenticator' + + @staticmethod + def ice_staticId(): + return '::MumbleServer::ServerUpdatingAuthenticator' + + def registerUser(self, info, current=None): + """ + Register a new user. + Arguments: + info -- Information about user to register. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'registerUser' not implemented") + + def unregisterUser(self, id, current=None): + """ + Unregister a user. + Arguments: + id -- Userid to unregister. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'unregisterUser' not implemented") + + def getRegisteredUsers(self, filter, current=None): + """ + Get a list of registered users matching filter. + Arguments: + filter -- Substring usernames must contain. If empty, return all registered users. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getRegisteredUsers' not implemented") + + def setInfo(self, id, info, current=None): + """ + Set additional information for user registration. + Arguments: + id -- Userid of registered user. + info -- Information to set about user. This should be merged with existing information. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'setInfo' not implemented") + + def setTexture(self, id, tex, current=None): + """ + Set texture (now called avatar) of user registration. + Arguments: + id -- registrationId of registered user. + tex -- New texture. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'setTexture' not implemented") + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_ServerUpdatingAuthenticatorDisp) + + __repr__ = __str__ + + _M_MumbleServer._t_ServerUpdatingAuthenticatorDisp = IcePy.defineClass('::MumbleServer::ServerUpdatingAuthenticator', ServerUpdatingAuthenticator, (), None, (_M_MumbleServer._t_ServerAuthenticatorDisp,)) + ServerUpdatingAuthenticator._ice_type = _M_MumbleServer._t_ServerUpdatingAuthenticatorDisp + + ServerUpdatingAuthenticator._op_registerUser = IcePy.Operation('registerUser', Ice.OperationMode.Normal, Ice.OperationMode.Normal, False, None, (), (((), _M_MumbleServer._t_UserInfoMap, False, 0),), (), ((), IcePy._t_int, False, 0), ()) + ServerUpdatingAuthenticator._op_unregisterUser = IcePy.Operation('unregisterUser', Ice.OperationMode.Normal, Ice.OperationMode.Normal, False, None, (), (((), IcePy._t_int, False, 0),), (), ((), IcePy._t_int, False, 0), ()) + ServerUpdatingAuthenticator._op_getRegisteredUsers = IcePy.Operation('getRegisteredUsers', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), IcePy._t_string, False, 0),), (), ((), _M_MumbleServer._t_NameMap, False, 0), ()) + ServerUpdatingAuthenticator._op_setInfo = IcePy.Operation('setInfo', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), IcePy._t_int, False, 0), ((), _M_MumbleServer._t_UserInfoMap, False, 0)), (), ((), IcePy._t_int, False, 0), ()) + ServerUpdatingAuthenticator._op_setTexture = IcePy.Operation('setTexture', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, False, None, (), (((), IcePy._t_int, False, 0), ((), _M_MumbleServer._t_Texture, False, 0)), (), ((), IcePy._t_int, False, 0), ()) + + _M_MumbleServer.ServerUpdatingAuthenticator = ServerUpdatingAuthenticator + del ServerUpdatingAuthenticator + +_M_MumbleServer._t_Server = IcePy.defineValue('::MumbleServer::Server', Ice.Value, -1, (), False, True, None, ()) + +if 'ServerPrx' not in _M_MumbleServer.__dict__: + _M_MumbleServer.ServerPrx = Ice.createTempClass() + class ServerPrx(Ice.ObjectPrx): + + """ + Shows if the server currently running (accepting users). + Arguments: + context -- The request context for the invocation. + Returns: Run-state of server. + """ + def isRunning(self, context=None): + return _M_MumbleServer.Server._op_isRunning.invoke(self, ((), context)) + + """ + Shows if the server currently running (accepting users). + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def isRunningAsync(self, context=None): + return _M_MumbleServer.Server._op_isRunning.invokeAsync(self, ((), context)) + + """ + Shows if the server currently running (accepting users). + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_isRunning(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_isRunning.begin(self, ((), _response, _ex, _sent, context)) + + """ + Shows if the server currently running (accepting users). + Arguments: + Returns: Run-state of server. + """ + def end_isRunning(self, _r): + return _M_MumbleServer.Server._op_isRunning.end(self, _r) + + """ + Start server. + Arguments: + context -- The request context for the invocation. + """ + def start(self, context=None): + return _M_MumbleServer.Server._op_start.invoke(self, ((), context)) + + """ + Start server. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def startAsync(self, context=None): + return _M_MumbleServer.Server._op_start.invokeAsync(self, ((), context)) + + """ + Start server. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_start(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_start.begin(self, ((), _response, _ex, _sent, context)) + + """ + Start server. + Arguments: + """ + def end_start(self, _r): + return _M_MumbleServer.Server._op_start.end(self, _r) + + """ + Stop server. + Note: Server will be restarted on Murmur restart unless explicitly disabled + with setConf("boot", false) + Arguments: + context -- The request context for the invocation. + """ + def stop(self, context=None): + return _M_MumbleServer.Server._op_stop.invoke(self, ((), context)) + + """ + Stop server. + Note: Server will be restarted on Murmur restart unless explicitly disabled + with setConf("boot", false) + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def stopAsync(self, context=None): + return _M_MumbleServer.Server._op_stop.invokeAsync(self, ((), context)) + + """ + Stop server. + Note: Server will be restarted on Murmur restart unless explicitly disabled + with setConf("boot", false) + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_stop(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_stop.begin(self, ((), _response, _ex, _sent, context)) + + """ + Stop server. + Note: Server will be restarted on Murmur restart unless explicitly disabled + with setConf("boot", false) + Arguments: + """ + def end_stop(self, _r): + return _M_MumbleServer.Server._op_stop.end(self, _r) + + """ + Delete server and all it's configuration. + Arguments: + context -- The request context for the invocation. + """ + def delete(self, context=None): + return _M_MumbleServer.Server._op_delete.invoke(self, ((), context)) + + """ + Delete server and all it's configuration. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def deleteAsync(self, context=None): + return _M_MumbleServer.Server._op_delete.invokeAsync(self, ((), context)) + + """ + Delete server and all it's configuration. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_delete(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_delete.begin(self, ((), _response, _ex, _sent, context)) + + """ + Delete server and all it's configuration. + Arguments: + """ + def end_delete(self, _r): + return _M_MumbleServer.Server._op_delete.end(self, _r) + + """ + Fetch the server id. + Arguments: + context -- The request context for the invocation. + Returns: Unique server id. + """ + def id(self, context=None): + return _M_MumbleServer.Server._op_id.invoke(self, ((), context)) + + """ + Fetch the server id. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def idAsync(self, context=None): + return _M_MumbleServer.Server._op_id.invokeAsync(self, ((), context)) + + """ + Fetch the server id. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_id(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_id.begin(self, ((), _response, _ex, _sent, context)) + + """ + Fetch the server id. + Arguments: + Returns: Unique server id. + """ + def end_id(self, _r): + return _M_MumbleServer.Server._op_id.end(self, _r) + + """ + Add a callback. The callback will receive notifications about changes to users and channels. + Arguments: + cb -- Callback interface which will receive notifications. + context -- The request context for the invocation. + """ + def addCallback(self, cb, context=None): + return _M_MumbleServer.Server._op_addCallback.invoke(self, ((cb, ), context)) + + """ + Add a callback. The callback will receive notifications about changes to users and channels. + Arguments: + cb -- Callback interface which will receive notifications. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def addCallbackAsync(self, cb, context=None): + return _M_MumbleServer.Server._op_addCallback.invokeAsync(self, ((cb, ), context)) + + """ + Add a callback. The callback will receive notifications about changes to users and channels. + Arguments: + cb -- Callback interface which will receive notifications. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_addCallback(self, cb, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_addCallback.begin(self, ((cb, ), _response, _ex, _sent, context)) + + """ + Add a callback. The callback will receive notifications about changes to users and channels. + Arguments: + cb -- Callback interface which will receive notifications. + """ + def end_addCallback(self, _r): + return _M_MumbleServer.Server._op_addCallback.end(self, _r) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. + context -- The request context for the invocation. + """ + def removeCallback(self, cb, context=None): + return _M_MumbleServer.Server._op_removeCallback.invoke(self, ((cb, ), context)) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def removeCallbackAsync(self, cb, context=None): + return _M_MumbleServer.Server._op_removeCallback.invokeAsync(self, ((cb, ), context)) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_removeCallback(self, cb, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_removeCallback.begin(self, ((cb, ), _response, _ex, _sent, context)) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. + """ + def end_removeCallback(self, _r): + return _M_MumbleServer.Server._op_removeCallback.end(self, _r) + + """ + Set external authenticator. If set, all authentications from clients are forwarded to this + proxy. + Arguments: + auth -- Authenticator object to perform subsequent authentications. + context -- The request context for the invocation. + """ + def setAuthenticator(self, auth, context=None): + return _M_MumbleServer.Server._op_setAuthenticator.invoke(self, ((auth, ), context)) + + """ + Set external authenticator. If set, all authentications from clients are forwarded to this + proxy. + Arguments: + auth -- Authenticator object to perform subsequent authentications. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def setAuthenticatorAsync(self, auth, context=None): + return _M_MumbleServer.Server._op_setAuthenticator.invokeAsync(self, ((auth, ), context)) + + """ + Set external authenticator. If set, all authentications from clients are forwarded to this + proxy. + Arguments: + auth -- Authenticator object to perform subsequent authentications. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_setAuthenticator(self, auth, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_setAuthenticator.begin(self, ((auth, ), _response, _ex, _sent, context)) + + """ + Set external authenticator. If set, all authentications from clients are forwarded to this + proxy. + Arguments: + auth -- Authenticator object to perform subsequent authentications. + """ + def end_setAuthenticator(self, _r): + return _M_MumbleServer.Server._op_setAuthenticator.end(self, _r) + + """ + Retrieve configuration item. + Arguments: + key -- Configuration key. + context -- The request context for the invocation. + Returns: Configuration value. If this is empty, see Meta.getDefaultConf + """ + def getConf(self, key, context=None): + return _M_MumbleServer.Server._op_getConf.invoke(self, ((key, ), context)) + + """ + Retrieve configuration item. + Arguments: + key -- Configuration key. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getConfAsync(self, key, context=None): + return _M_MumbleServer.Server._op_getConf.invokeAsync(self, ((key, ), context)) + + """ + Retrieve configuration item. + Arguments: + key -- Configuration key. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getConf(self, key, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getConf.begin(self, ((key, ), _response, _ex, _sent, context)) + + """ + Retrieve configuration item. + Arguments: + key -- Configuration key. + Returns: Configuration value. If this is empty, see Meta.getDefaultConf + """ + def end_getConf(self, _r): + return _M_MumbleServer.Server._op_getConf.end(self, _r) + + """ + Retrieve all configuration items. + Arguments: + context -- The request context for the invocation. + Returns: All configured values. If a value isn't set here, the value from Meta.getDefaultConf is used. + """ + def getAllConf(self, context=None): + return _M_MumbleServer.Server._op_getAllConf.invoke(self, ((), context)) + + """ + Retrieve all configuration items. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getAllConfAsync(self, context=None): + return _M_MumbleServer.Server._op_getAllConf.invokeAsync(self, ((), context)) + + """ + Retrieve all configuration items. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getAllConf(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getAllConf.begin(self, ((), _response, _ex, _sent, context)) + + """ + Retrieve all configuration items. + Arguments: + Returns: All configured values. If a value isn't set here, the value from Meta.getDefaultConf is used. + """ + def end_getAllConf(self, _r): + return _M_MumbleServer.Server._op_getAllConf.end(self, _r) + + """ + Set a configuration item. + Arguments: + key -- Configuration key. + value -- Configuration value. + context -- The request context for the invocation. + """ + def setConf(self, key, value, context=None): + return _M_MumbleServer.Server._op_setConf.invoke(self, ((key, value), context)) + + """ + Set a configuration item. + Arguments: + key -- Configuration key. + value -- Configuration value. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def setConfAsync(self, key, value, context=None): + return _M_MumbleServer.Server._op_setConf.invokeAsync(self, ((key, value), context)) + + """ + Set a configuration item. + Arguments: + key -- Configuration key. + value -- Configuration value. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_setConf(self, key, value, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_setConf.begin(self, ((key, value), _response, _ex, _sent, context)) + + """ + Set a configuration item. + Arguments: + key -- Configuration key. + value -- Configuration value. + """ + def end_setConf(self, _r): + return _M_MumbleServer.Server._op_setConf.end(self, _r) + + """ + Set superuser password. This is just a convenience for using updateRegistration on user id 0. + Arguments: + pw -- Password. + context -- The request context for the invocation. + """ + def setSuperuserPassword(self, pw, context=None): + return _M_MumbleServer.Server._op_setSuperuserPassword.invoke(self, ((pw, ), context)) + + """ + Set superuser password. This is just a convenience for using updateRegistration on user id 0. + Arguments: + pw -- Password. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def setSuperuserPasswordAsync(self, pw, context=None): + return _M_MumbleServer.Server._op_setSuperuserPassword.invokeAsync(self, ((pw, ), context)) + + """ + Set superuser password. This is just a convenience for using updateRegistration on user id 0. + Arguments: + pw -- Password. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_setSuperuserPassword(self, pw, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_setSuperuserPassword.begin(self, ((pw, ), _response, _ex, _sent, context)) + + """ + Set superuser password. This is just a convenience for using updateRegistration on user id 0. + Arguments: + pw -- Password. + """ + def end_setSuperuserPassword(self, _r): + return _M_MumbleServer.Server._op_setSuperuserPassword.end(self, _r) + + """ + Fetch log entries. + Arguments: + first -- Lowest numbered entry to fetch. 0 is the most recent item. + last -- Last entry to fetch. + context -- The request context for the invocation. + Returns: List of log entries. + """ + def getLog(self, first, last, context=None): + return _M_MumbleServer.Server._op_getLog.invoke(self, ((first, last), context)) + + """ + Fetch log entries. + Arguments: + first -- Lowest numbered entry to fetch. 0 is the most recent item. + last -- Last entry to fetch. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getLogAsync(self, first, last, context=None): + return _M_MumbleServer.Server._op_getLog.invokeAsync(self, ((first, last), context)) + + """ + Fetch log entries. + Arguments: + first -- Lowest numbered entry to fetch. 0 is the most recent item. + last -- Last entry to fetch. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getLog(self, first, last, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getLog.begin(self, ((first, last), _response, _ex, _sent, context)) + + """ + Fetch log entries. + Arguments: + first -- Lowest numbered entry to fetch. 0 is the most recent item. + last -- Last entry to fetch. + Returns: List of log entries. + """ + def end_getLog(self, _r): + return _M_MumbleServer.Server._op_getLog.end(self, _r) + + """ + Fetch length of log + Arguments: + context -- The request context for the invocation. + Returns: Number of entries in log + """ + def getLogLen(self, context=None): + return _M_MumbleServer.Server._op_getLogLen.invoke(self, ((), context)) + + """ + Fetch length of log + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getLogLenAsync(self, context=None): + return _M_MumbleServer.Server._op_getLogLen.invokeAsync(self, ((), context)) + + """ + Fetch length of log + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getLogLen(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getLogLen.begin(self, ((), _response, _ex, _sent, context)) + + """ + Fetch length of log + Arguments: + Returns: Number of entries in log + """ + def end_getLogLen(self, _r): + return _M_MumbleServer.Server._op_getLogLen.end(self, _r) + + """ + Fetch all users. This returns all currently connected users on the server. + Arguments: + context -- The request context for the invocation. + Returns: List of connected users. + """ + def getUsers(self, context=None): + return _M_MumbleServer.Server._op_getUsers.invoke(self, ((), context)) + + """ + Fetch all users. This returns all currently connected users on the server. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getUsersAsync(self, context=None): + return _M_MumbleServer.Server._op_getUsers.invokeAsync(self, ((), context)) + + """ + Fetch all users. This returns all currently connected users on the server. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getUsers(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getUsers.begin(self, ((), _response, _ex, _sent, context)) + + """ + Fetch all users. This returns all currently connected users on the server. + Arguments: + Returns: List of connected users. + """ + def end_getUsers(self, _r): + return _M_MumbleServer.Server._op_getUsers.end(self, _r) + + """ + Fetch all channels. This returns all defined channels on the server. The root channel is always channel 0. + Arguments: + context -- The request context for the invocation. + Returns: List of defined channels. + """ + def getChannels(self, context=None): + return _M_MumbleServer.Server._op_getChannels.invoke(self, ((), context)) + + """ + Fetch all channels. This returns all defined channels on the server. The root channel is always channel 0. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getChannelsAsync(self, context=None): + return _M_MumbleServer.Server._op_getChannels.invokeAsync(self, ((), context)) + + """ + Fetch all channels. This returns all defined channels on the server. The root channel is always channel 0. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getChannels(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getChannels.begin(self, ((), _response, _ex, _sent, context)) + + """ + Fetch all channels. This returns all defined channels on the server. The root channel is always channel 0. + Arguments: + Returns: List of defined channels. + """ + def end_getChannels(self, _r): + return _M_MumbleServer.Server._op_getChannels.end(self, _r) + + """ + Fetch certificate of user. This returns the complete certificate chain of a user. + Arguments: + session -- Connection ID of user. See User.session. + context -- The request context for the invocation. + Returns: Certificate list of user. + """ + def getCertificateList(self, session, context=None): + return _M_MumbleServer.Server._op_getCertificateList.invoke(self, ((session, ), context)) + + """ + Fetch certificate of user. This returns the complete certificate chain of a user. + Arguments: + session -- Connection ID of user. See User.session. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getCertificateListAsync(self, session, context=None): + return _M_MumbleServer.Server._op_getCertificateList.invokeAsync(self, ((session, ), context)) + + """ + Fetch certificate of user. This returns the complete certificate chain of a user. + Arguments: + session -- Connection ID of user. See User.session. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getCertificateList(self, session, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getCertificateList.begin(self, ((session, ), _response, _ex, _sent, context)) + + """ + Fetch certificate of user. This returns the complete certificate chain of a user. + Arguments: + session -- Connection ID of user. See User.session. + Returns: Certificate list of user. + """ + def end_getCertificateList(self, _r): + return _M_MumbleServer.Server._op_getCertificateList.end(self, _r) + + """ + Fetch all channels and connected users as a tree. This retrieves an easy-to-use representation of the server + as a tree. This is primarily used for viewing the state of the server on a webpage. + Arguments: + context -- The request context for the invocation. + Returns: Recursive tree of all channels and connected users. + """ + def getTree(self, context=None): + return _M_MumbleServer.Server._op_getTree.invoke(self, ((), context)) + + """ + Fetch all channels and connected users as a tree. This retrieves an easy-to-use representation of the server + as a tree. This is primarily used for viewing the state of the server on a webpage. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getTreeAsync(self, context=None): + return _M_MumbleServer.Server._op_getTree.invokeAsync(self, ((), context)) + + """ + Fetch all channels and connected users as a tree. This retrieves an easy-to-use representation of the server + as a tree. This is primarily used for viewing the state of the server on a webpage. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getTree(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getTree.begin(self, ((), _response, _ex, _sent, context)) + + """ + Fetch all channels and connected users as a tree. This retrieves an easy-to-use representation of the server + as a tree. This is primarily used for viewing the state of the server on a webpage. + Arguments: + Returns: Recursive tree of all channels and connected users. + """ + def end_getTree(self, _r): + return _M_MumbleServer.Server._op_getTree.end(self, _r) + + """ + Fetch all current IP bans on the server. + Arguments: + context -- The request context for the invocation. + Returns: List of bans. + """ + def getBans(self, context=None): + return _M_MumbleServer.Server._op_getBans.invoke(self, ((), context)) + + """ + Fetch all current IP bans on the server. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getBansAsync(self, context=None): + return _M_MumbleServer.Server._op_getBans.invokeAsync(self, ((), context)) + + """ + Fetch all current IP bans on the server. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getBans(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getBans.begin(self, ((), _response, _ex, _sent, context)) + + """ + Fetch all current IP bans on the server. + Arguments: + Returns: List of bans. + """ + def end_getBans(self, _r): + return _M_MumbleServer.Server._op_getBans.end(self, _r) + + """ + 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 + append to the returned list before calling this method. + Arguments: + bans -- List of bans. + context -- The request context for the invocation. + """ + def setBans(self, bans, context=None): + return _M_MumbleServer.Server._op_setBans.invoke(self, ((bans, ), context)) + + """ + 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 + append to the returned list before calling this method. + Arguments: + bans -- List of bans. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def setBansAsync(self, bans, context=None): + return _M_MumbleServer.Server._op_setBans.invokeAsync(self, ((bans, ), context)) + + """ + 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 + append to the returned list before calling this method. + Arguments: + bans -- List of bans. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_setBans(self, bans, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_setBans.begin(self, ((bans, ), _response, _ex, _sent, context)) + + """ + 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 + append to the returned list before calling this method. + Arguments: + bans -- List of bans. + """ + def end_setBans(self, _r): + return _M_MumbleServer.Server._op_setBans.end(self, _r) + + """ + Kick a user. The user is not banned, and is free to rejoin the server. + Arguments: + session -- Connection ID of user. See User.session. + reason -- Text message to show when user is kicked. + context -- The request context for the invocation. + """ + def kickUser(self, session, reason, context=None): + return _M_MumbleServer.Server._op_kickUser.invoke(self, ((session, reason), context)) + + """ + Kick a user. The user is not banned, and is free to rejoin the server. + Arguments: + session -- Connection ID of user. See User.session. + reason -- Text message to show when user is kicked. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def kickUserAsync(self, session, reason, context=None): + return _M_MumbleServer.Server._op_kickUser.invokeAsync(self, ((session, reason), context)) + + """ + Kick a user. The user is not banned, and is free to rejoin the server. + Arguments: + session -- Connection ID of user. See User.session. + reason -- Text message to show when user is kicked. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_kickUser(self, session, reason, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_kickUser.begin(self, ((session, reason), _response, _ex, _sent, context)) + + """ + Kick a user. The user is not banned, and is free to rejoin the server. + Arguments: + session -- Connection ID of user. See User.session. + reason -- Text message to show when user is kicked. + """ + def end_kickUser(self, _r): + return _M_MumbleServer.Server._op_kickUser.end(self, _r) + + """ + Get state of a single connected user. + Arguments: + session -- Connection ID of user. See User.session. + context -- The request context for the invocation. + Returns: State of connected user. + """ + def getState(self, session, context=None): + return _M_MumbleServer.Server._op_getState.invoke(self, ((session, ), context)) + + """ + Get state of a single connected user. + Arguments: + session -- Connection ID of user. See User.session. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getStateAsync(self, session, context=None): + return _M_MumbleServer.Server._op_getState.invokeAsync(self, ((session, ), context)) + + """ + Get state of a single connected user. + Arguments: + session -- Connection ID of user. See User.session. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getState(self, session, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getState.begin(self, ((session, ), _response, _ex, _sent, context)) + + """ + Get state of a single connected user. + Arguments: + session -- Connection ID of user. See User.session. + Returns: State of connected user. + """ + def end_getState(self, _r): + return _M_MumbleServer.Server._op_getState.end(self, _r) + + """ + Set user state. You can use this to move, mute and deafen users. + Arguments: + state -- User state to set. + context -- The request context for the invocation. + """ + def setState(self, state, context=None): + return _M_MumbleServer.Server._op_setState.invoke(self, ((state, ), context)) + + """ + Set user state. You can use this to move, mute and deafen users. + Arguments: + state -- User state to set. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def setStateAsync(self, state, context=None): + return _M_MumbleServer.Server._op_setState.invokeAsync(self, ((state, ), context)) + + """ + Set user state. You can use this to move, mute and deafen users. + Arguments: + state -- User state to set. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_setState(self, state, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_setState.begin(self, ((state, ), _response, _ex, _sent, context)) + + """ + Set user state. You can use this to move, mute and deafen users. + Arguments: + state -- User state to set. + """ + def end_setState(self, _r): + return _M_MumbleServer.Server._op_setState.end(self, _r) + + """ + Send text message to a single user. + Arguments: + session -- Connection ID of user. See User.session. + text -- Message to send. + context -- The request context for the invocation. + """ + def sendMessage(self, session, text, context=None): + return _M_MumbleServer.Server._op_sendMessage.invoke(self, ((session, text), context)) + + """ + Send text message to a single user. + Arguments: + session -- Connection ID of user. See User.session. + text -- Message to send. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def sendMessageAsync(self, session, text, context=None): + return _M_MumbleServer.Server._op_sendMessage.invokeAsync(self, ((session, text), context)) + + """ + Send text message to a single user. + Arguments: + session -- Connection ID of user. See User.session. + text -- Message to send. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_sendMessage(self, session, text, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_sendMessage.begin(self, ((session, text), _response, _ex, _sent, context)) + + """ + Send text message to a single user. + Arguments: + session -- Connection ID of user. See User.session. + text -- Message to send. + """ + def end_sendMessage(self, _r): + return _M_MumbleServer.Server._op_sendMessage.end(self, _r) + + """ + Check if user is permitted to perform action. + Arguments: + session -- Connection ID of user. See User.session. + channelid -- ID of Channel. See Channel.id. + perm -- Permission bits to check. + context -- The request context for the invocation. + Returns: true if any of the permissions in perm were set for the user. + """ + def hasPermission(self, session, channelid, perm, context=None): + return _M_MumbleServer.Server._op_hasPermission.invoke(self, ((session, channelid, perm), context)) + + """ + Check if user is permitted to perform action. + Arguments: + session -- Connection ID of user. See User.session. + channelid -- ID of Channel. See Channel.id. + perm -- Permission bits to check. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def hasPermissionAsync(self, session, channelid, perm, context=None): + return _M_MumbleServer.Server._op_hasPermission.invokeAsync(self, ((session, channelid, perm), context)) + + """ + Check if user is permitted to perform action. + Arguments: + session -- Connection ID of user. See User.session. + channelid -- ID of Channel. See Channel.id. + perm -- Permission bits to check. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_hasPermission(self, session, channelid, perm, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_hasPermission.begin(self, ((session, channelid, perm), _response, _ex, _sent, context)) + + """ + Check if user is permitted to perform action. + Arguments: + session -- Connection ID of user. See User.session. + channelid -- ID of Channel. See Channel.id. + perm -- Permission bits to check. + Returns: true if any of the permissions in perm were set for the user. + """ + def end_hasPermission(self, _r): + return _M_MumbleServer.Server._op_hasPermission.end(self, _r) + + """ + Return users effective permissions + Arguments: + session -- Connection ID of user. See User.session. + channelid -- ID of Channel. See Channel.id. + context -- The request context for the invocation. + Returns: bitfield of allowed actions + """ + def effectivePermissions(self, session, channelid, context=None): + return _M_MumbleServer.Server._op_effectivePermissions.invoke(self, ((session, channelid), context)) + + """ + Return users effective permissions + Arguments: + session -- Connection ID of user. See User.session. + channelid -- ID of Channel. See Channel.id. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def effectivePermissionsAsync(self, session, channelid, context=None): + return _M_MumbleServer.Server._op_effectivePermissions.invokeAsync(self, ((session, channelid), context)) + + """ + Return users effective permissions + Arguments: + session -- Connection ID of user. See User.session. + channelid -- ID of Channel. See Channel.id. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_effectivePermissions(self, session, channelid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_effectivePermissions.begin(self, ((session, channelid), _response, _ex, _sent, context)) + + """ + Return users effective permissions + Arguments: + session -- Connection ID of user. See User.session. + channelid -- ID of Channel. See Channel.id. + Returns: bitfield of allowed actions + """ + def end_effectivePermissions(self, _r): + return _M_MumbleServer.Server._op_effectivePermissions.end(self, _r) + + """ + Add a context callback. This is done per user, and will add a context menu action for the user. + Arguments: + session -- Session of user which should receive context entry. + action -- Action string, a unique name to associate with the action. + text -- Name of action shown to user. + cb -- Callback interface which will receive notifications. + ctx -- Context this should be used in. Needs to be one or a combination of ContextServer, ContextChannel and ContextUser. + context -- The request context for the invocation. + """ + def addContextCallback(self, session, action, text, cb, ctx, context=None): + return _M_MumbleServer.Server._op_addContextCallback.invoke(self, ((session, action, text, cb, ctx), context)) + + """ + Add a context callback. This is done per user, and will add a context menu action for the user. + Arguments: + session -- Session of user which should receive context entry. + action -- Action string, a unique name to associate with the action. + text -- Name of action shown to user. + cb -- Callback interface which will receive notifications. + ctx -- Context this should be used in. Needs to be one or a combination of ContextServer, ContextChannel and ContextUser. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def addContextCallbackAsync(self, session, action, text, cb, ctx, context=None): + return _M_MumbleServer.Server._op_addContextCallback.invokeAsync(self, ((session, action, text, cb, ctx), context)) + + """ + Add a context callback. This is done per user, and will add a context menu action for the user. + Arguments: + session -- Session of user which should receive context entry. + action -- Action string, a unique name to associate with the action. + text -- Name of action shown to user. + cb -- Callback interface which will receive notifications. + ctx -- Context this should be used in. Needs to be one or a combination of ContextServer, ContextChannel and ContextUser. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_addContextCallback(self, session, action, text, cb, ctx, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_addContextCallback.begin(self, ((session, action, text, cb, ctx), _response, _ex, _sent, context)) + + """ + Add a context callback. This is done per user, and will add a context menu action for the user. + Arguments: + session -- Session of user which should receive context entry. + action -- Action string, a unique name to associate with the action. + text -- Name of action shown to user. + cb -- Callback interface which will receive notifications. + ctx -- Context this should be used in. Needs to be one or a combination of ContextServer, ContextChannel and ContextUser. + """ + def end_addContextCallback(self, _r): + return _M_MumbleServer.Server._op_addContextCallback.end(self, _r) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. This callback will be removed from all from all users. + context -- The request context for the invocation. + """ + def removeContextCallback(self, cb, context=None): + return _M_MumbleServer.Server._op_removeContextCallback.invoke(self, ((cb, ), context)) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. This callback will be removed from all from all users. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def removeContextCallbackAsync(self, cb, context=None): + return _M_MumbleServer.Server._op_removeContextCallback.invokeAsync(self, ((cb, ), context)) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. This callback will be removed from all from all users. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_removeContextCallback(self, cb, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_removeContextCallback.begin(self, ((cb, ), _response, _ex, _sent, context)) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. This callback will be removed from all from all users. + """ + def end_removeContextCallback(self, _r): + return _M_MumbleServer.Server._op_removeContextCallback.end(self, _r) + + """ + Get state of single channel. + Arguments: + channelid -- ID of Channel. See Channel.id. + context -- The request context for the invocation. + Returns: State of channel. + """ + def getChannelState(self, channelid, context=None): + return _M_MumbleServer.Server._op_getChannelState.invoke(self, ((channelid, ), context)) + + """ + Get state of single channel. + Arguments: + channelid -- ID of Channel. See Channel.id. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getChannelStateAsync(self, channelid, context=None): + return _M_MumbleServer.Server._op_getChannelState.invokeAsync(self, ((channelid, ), context)) + + """ + Get state of single channel. + Arguments: + channelid -- ID of Channel. See Channel.id. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getChannelState(self, channelid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getChannelState.begin(self, ((channelid, ), _response, _ex, _sent, context)) + + """ + Get state of single channel. + Arguments: + channelid -- ID of Channel. See Channel.id. + Returns: State of channel. + """ + def end_getChannelState(self, _r): + return _M_MumbleServer.Server._op_getChannelState.end(self, _r) + + """ + Set state of a single channel. You can use this to move or relink channels. + Arguments: + state -- Channel state to set. + context -- The request context for the invocation. + """ + def setChannelState(self, state, context=None): + return _M_MumbleServer.Server._op_setChannelState.invoke(self, ((state, ), context)) + + """ + Set state of a single channel. You can use this to move or relink channels. + Arguments: + state -- Channel state to set. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def setChannelStateAsync(self, state, context=None): + return _M_MumbleServer.Server._op_setChannelState.invokeAsync(self, ((state, ), context)) + + """ + Set state of a single channel. You can use this to move or relink channels. + Arguments: + state -- Channel state to set. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_setChannelState(self, state, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_setChannelState.begin(self, ((state, ), _response, _ex, _sent, context)) + + """ + Set state of a single channel. You can use this to move or relink channels. + Arguments: + state -- Channel state to set. + """ + def end_setChannelState(self, _r): + return _M_MumbleServer.Server._op_setChannelState.end(self, _r) + + """ + Remove a channel and all its subchannels. + Arguments: + channelid -- ID of Channel. See Channel.id. + context -- The request context for the invocation. + """ + def removeChannel(self, channelid, context=None): + return _M_MumbleServer.Server._op_removeChannel.invoke(self, ((channelid, ), context)) + + """ + Remove a channel and all its subchannels. + Arguments: + channelid -- ID of Channel. See Channel.id. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def removeChannelAsync(self, channelid, context=None): + return _M_MumbleServer.Server._op_removeChannel.invokeAsync(self, ((channelid, ), context)) + + """ + Remove a channel and all its subchannels. + Arguments: + channelid -- ID of Channel. See Channel.id. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_removeChannel(self, channelid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_removeChannel.begin(self, ((channelid, ), _response, _ex, _sent, context)) + + """ + Remove a channel and all its subchannels. + Arguments: + channelid -- ID of Channel. See Channel.id. + """ + def end_removeChannel(self, _r): + return _M_MumbleServer.Server._op_removeChannel.end(self, _r) + + """ + Add a new channel. + Arguments: + name -- Name of new channel. + parent -- Channel ID of parent channel. See Channel.id. + context -- The request context for the invocation. + Returns: ID of newly created channel. + """ + def addChannel(self, name, parent, context=None): + return _M_MumbleServer.Server._op_addChannel.invoke(self, ((name, parent), context)) + + """ + Add a new channel. + Arguments: + name -- Name of new channel. + parent -- Channel ID of parent channel. See Channel.id. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def addChannelAsync(self, name, parent, context=None): + return _M_MumbleServer.Server._op_addChannel.invokeAsync(self, ((name, parent), context)) + + """ + Add a new channel. + Arguments: + name -- Name of new channel. + parent -- Channel ID of parent channel. See Channel.id. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_addChannel(self, name, parent, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_addChannel.begin(self, ((name, parent), _response, _ex, _sent, context)) + + """ + Add a new channel. + Arguments: + name -- Name of new channel. + parent -- Channel ID of parent channel. See Channel.id. + Returns: ID of newly created channel. + """ + def end_addChannel(self, _r): + return _M_MumbleServer.Server._op_addChannel.end(self, _r) + + """ + Send text message to channel or a tree of channels. + Arguments: + channelid -- Channel ID of channel to send to. See Channel.id. + tree -- If true, the message will be sent to the channel and all its subchannels. + text -- Message to send. + context -- The request context for the invocation. + """ + def sendMessageChannel(self, channelid, tree, text, context=None): + return _M_MumbleServer.Server._op_sendMessageChannel.invoke(self, ((channelid, tree, text), context)) + + """ + Send text message to channel or a tree of channels. + Arguments: + channelid -- Channel ID of channel to send to. See Channel.id. + tree -- If true, the message will be sent to the channel and all its subchannels. + text -- Message to send. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def sendMessageChannelAsync(self, channelid, tree, text, context=None): + return _M_MumbleServer.Server._op_sendMessageChannel.invokeAsync(self, ((channelid, tree, text), context)) + + """ + Send text message to channel or a tree of channels. + Arguments: + channelid -- Channel ID of channel to send to. See Channel.id. + tree -- If true, the message will be sent to the channel and all its subchannels. + text -- Message to send. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_sendMessageChannel(self, channelid, tree, text, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_sendMessageChannel.begin(self, ((channelid, tree, text), _response, _ex, _sent, context)) + + """ + Send text message to channel or a tree of channels. + Arguments: + channelid -- Channel ID of channel to send to. See Channel.id. + tree -- If true, the message will be sent to the channel and all its subchannels. + text -- Message to send. + """ + def end_sendMessageChannel(self, _r): + return _M_MumbleServer.Server._op_sendMessageChannel.end(self, _r) + + """ + Retrieve ACLs and Groups on a channel. + Arguments: + channelid -- Channel ID of channel to fetch from. See Channel.id. + context -- The request context for the invocation. + Returns a tuple containing the following: + acls -- List of ACLs on the channel. This will include inherited ACLs. + groups -- List of groups on the channel. This will include inherited groups. + inherit -- Does this channel inherit ACLs from the parent channel? + """ + def getACL(self, channelid, context=None): + return _M_MumbleServer.Server._op_getACL.invoke(self, ((channelid, ), context)) + + """ + Retrieve ACLs and Groups on a channel. + Arguments: + channelid -- Channel ID of channel to fetch from. See Channel.id. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getACLAsync(self, channelid, context=None): + return _M_MumbleServer.Server._op_getACL.invokeAsync(self, ((channelid, ), context)) + + """ + Retrieve ACLs and Groups on a channel. + Arguments: + channelid -- Channel ID of channel to fetch from. See Channel.id. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getACL(self, channelid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getACL.begin(self, ((channelid, ), _response, _ex, _sent, context)) + + """ + Retrieve ACLs and Groups on a channel. + Arguments: + channelid -- Channel ID of channel to fetch from. See Channel.id. + Returns a tuple containing the following: + acls -- List of ACLs on the channel. This will include inherited ACLs. + groups -- List of groups on the channel. This will include inherited groups. + inherit -- Does this channel inherit ACLs from the parent channel? + """ + def end_getACL(self, _r): + return _M_MumbleServer.Server._op_getACL.end(self, _r) + + """ + Set ACLs and Groups on a channel. Note that this will replace all existing ACLs and groups on the channel. + Arguments: + channelid -- Channel ID of channel to fetch from. See Channel.id. + acls -- List of ACLs on the channel. + groups -- List of groups on the channel. + inherit -- Should this channel inherit ACLs from the parent channel? + context -- The request context for the invocation. + """ + def setACL(self, channelid, acls, groups, inherit, context=None): + return _M_MumbleServer.Server._op_setACL.invoke(self, ((channelid, acls, groups, inherit), context)) + + """ + Set ACLs and Groups on a channel. Note that this will replace all existing ACLs and groups on the channel. + Arguments: + channelid -- Channel ID of channel to fetch from. See Channel.id. + acls -- List of ACLs on the channel. + groups -- List of groups on the channel. + inherit -- Should this channel inherit ACLs from the parent channel? + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def setACLAsync(self, channelid, acls, groups, inherit, context=None): + return _M_MumbleServer.Server._op_setACL.invokeAsync(self, ((channelid, acls, groups, inherit), context)) + + """ + Set ACLs and Groups on a channel. Note that this will replace all existing ACLs and groups on the channel. + Arguments: + channelid -- Channel ID of channel to fetch from. See Channel.id. + acls -- List of ACLs on the channel. + groups -- List of groups on the channel. + inherit -- Should this channel inherit ACLs from the parent channel? + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_setACL(self, channelid, acls, groups, inherit, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_setACL.begin(self, ((channelid, acls, groups, inherit), _response, _ex, _sent, context)) + + """ + Set ACLs and Groups on a channel. Note that this will replace all existing ACLs and groups on the channel. + Arguments: + channelid -- Channel ID of channel to fetch from. See Channel.id. + acls -- List of ACLs on the channel. + groups -- List of groups on the channel. + inherit -- Should this channel inherit ACLs from the parent channel? + """ + def end_setACL(self, _r): + return _M_MumbleServer.Server._op_setACL.end(self, _r) + + """ + Temporarily add a user to a group on a channel. This state is not saved, and is intended for temporary memberships. + Arguments: + channelid -- Channel ID of channel to add to. See Channel.id. + session -- Connection ID of user. See User.session. + group -- Group name to add to. + context -- The request context for the invocation. + """ + def addUserToGroup(self, channelid, session, group, context=None): + return _M_MumbleServer.Server._op_addUserToGroup.invoke(self, ((channelid, session, group), context)) + + """ + Temporarily add a user to a group on a channel. This state is not saved, and is intended for temporary memberships. + Arguments: + channelid -- Channel ID of channel to add to. See Channel.id. + session -- Connection ID of user. See User.session. + group -- Group name to add to. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def addUserToGroupAsync(self, channelid, session, group, context=None): + return _M_MumbleServer.Server._op_addUserToGroup.invokeAsync(self, ((channelid, session, group), context)) + + """ + Temporarily add a user to a group on a channel. This state is not saved, and is intended for temporary memberships. + Arguments: + channelid -- Channel ID of channel to add to. See Channel.id. + session -- Connection ID of user. See User.session. + group -- Group name to add to. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_addUserToGroup(self, channelid, session, group, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_addUserToGroup.begin(self, ((channelid, session, group), _response, _ex, _sent, context)) + + """ + Temporarily add a user to a group on a channel. This state is not saved, and is intended for temporary memberships. + Arguments: + channelid -- Channel ID of channel to add to. See Channel.id. + session -- Connection ID of user. See User.session. + group -- Group name to add to. + """ + def end_addUserToGroup(self, _r): + return _M_MumbleServer.Server._op_addUserToGroup.end(self, _r) + + """ + Remove a user from a temporary group membership on a channel. This state is not saved, and is intended for temporary memberships. + Arguments: + channelid -- Channel ID of channel to add to. See Channel.id. + session -- Connection ID of user. See User.session. + group -- Group name to remove from. + context -- The request context for the invocation. + """ + def removeUserFromGroup(self, channelid, session, group, context=None): + return _M_MumbleServer.Server._op_removeUserFromGroup.invoke(self, ((channelid, session, group), context)) + + """ + Remove a user from a temporary group membership on a channel. This state is not saved, and is intended for temporary memberships. + Arguments: + channelid -- Channel ID of channel to add to. See Channel.id. + session -- Connection ID of user. See User.session. + group -- Group name to remove from. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def removeUserFromGroupAsync(self, channelid, session, group, context=None): + return _M_MumbleServer.Server._op_removeUserFromGroup.invokeAsync(self, ((channelid, session, group), context)) + + """ + Remove a user from a temporary group membership on a channel. This state is not saved, and is intended for temporary memberships. + Arguments: + channelid -- Channel ID of channel to add to. See Channel.id. + session -- Connection ID of user. See User.session. + group -- Group name to remove from. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_removeUserFromGroup(self, channelid, session, group, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_removeUserFromGroup.begin(self, ((channelid, session, group), _response, _ex, _sent, context)) + + """ + Remove a user from a temporary group membership on a channel. This state is not saved, and is intended for temporary memberships. + Arguments: + channelid -- Channel ID of channel to add to. See Channel.id. + session -- Connection ID of user. See User.session. + group -- Group name to remove from. + """ + def end_removeUserFromGroup(self, _r): + return _M_MumbleServer.Server._op_removeUserFromGroup.end(self, _r) + + """ + 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. + Arguments: + session -- Connection ID of user. See User.session. + source -- Group name to redirect from. + target -- Group name to redirect to. + context -- The request context for the invocation. + """ + def redirectWhisperGroup(self, session, source, target, context=None): + return _M_MumbleServer.Server._op_redirectWhisperGroup.invoke(self, ((session, source, target), context)) + + """ + 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. + Arguments: + session -- Connection ID of user. See User.session. + source -- Group name to redirect from. + target -- Group name to redirect to. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def redirectWhisperGroupAsync(self, session, source, target, context=None): + return _M_MumbleServer.Server._op_redirectWhisperGroup.invokeAsync(self, ((session, source, target), context)) + + """ + 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. + Arguments: + session -- Connection ID of user. See User.session. + source -- Group name to redirect from. + target -- Group name to redirect to. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_redirectWhisperGroup(self, session, source, target, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_redirectWhisperGroup.begin(self, ((session, source, target), _response, _ex, _sent, context)) + + """ + 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. + Arguments: + session -- Connection ID of user. See User.session. + source -- Group name to redirect from. + target -- Group name to redirect to. + """ + def end_redirectWhisperGroup(self, _r): + return _M_MumbleServer.Server._op_redirectWhisperGroup.end(self, _r) + + """ + Map a list of User.userid to a matching name. + Arguments: + ids -- + context -- The request context for the invocation. + Returns: Matching list of names, with an empty string representing invalid or unknown ids. + """ + def getUserNames(self, ids, context=None): + return _M_MumbleServer.Server._op_getUserNames.invoke(self, ((ids, ), context)) + + """ + Map a list of User.userid to a matching name. + Arguments: + ids -- + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getUserNamesAsync(self, ids, context=None): + return _M_MumbleServer.Server._op_getUserNames.invokeAsync(self, ((ids, ), context)) + + """ + Map a list of User.userid to a matching name. + Arguments: + ids -- + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getUserNames(self, ids, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getUserNames.begin(self, ((ids, ), _response, _ex, _sent, context)) + + """ + Map a list of User.userid to a matching name. + Arguments: + ids -- + Returns: Matching list of names, with an empty string representing invalid or unknown ids. + """ + def end_getUserNames(self, _r): + return _M_MumbleServer.Server._op_getUserNames.end(self, _r) + + """ + Map a list of user names to a matching id. + @reuturn List of matching ids, with -1 representing invalid or unknown user names. + Arguments: + names -- + context -- The request context for the invocation. + """ + def getUserIds(self, names, context=None): + return _M_MumbleServer.Server._op_getUserIds.invoke(self, ((names, ), context)) + + """ + Map a list of user names to a matching id. + @reuturn List of matching ids, with -1 representing invalid or unknown user names. + Arguments: + names -- + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getUserIdsAsync(self, names, context=None): + return _M_MumbleServer.Server._op_getUserIds.invokeAsync(self, ((names, ), context)) + + """ + Map a list of user names to a matching id. + @reuturn List of matching ids, with -1 representing invalid or unknown user names. + Arguments: + names -- + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getUserIds(self, names, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getUserIds.begin(self, ((names, ), _response, _ex, _sent, context)) + + """ + Map a list of user names to a matching id. + @reuturn List of matching ids, with -1 representing invalid or unknown user names. + Arguments: + names -- + """ + def end_getUserIds(self, _r): + return _M_MumbleServer.Server._op_getUserIds.end(self, _r) + + """ + Register a new user. + Arguments: + info -- Information about new user. Must include at least "name". + context -- The request context for the invocation. + Returns: The ID of the user. See RegisteredUser.userid. + """ + def registerUser(self, info, context=None): + return _M_MumbleServer.Server._op_registerUser.invoke(self, ((info, ), context)) + + """ + Register a new user. + Arguments: + info -- Information about new user. Must include at least "name". + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def registerUserAsync(self, info, context=None): + return _M_MumbleServer.Server._op_registerUser.invokeAsync(self, ((info, ), context)) + + """ + Register a new user. + Arguments: + info -- Information about new user. Must include at least "name". + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_registerUser(self, info, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_registerUser.begin(self, ((info, ), _response, _ex, _sent, context)) + + """ + Register a new user. + Arguments: + info -- Information about new user. Must include at least "name". + Returns: The ID of the user. See RegisteredUser.userid. + """ + def end_registerUser(self, _r): + return _M_MumbleServer.Server._op_registerUser.end(self, _r) + + """ + Remove a user registration. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + context -- The request context for the invocation. + """ + def unregisterUser(self, userid, context=None): + return _M_MumbleServer.Server._op_unregisterUser.invoke(self, ((userid, ), context)) + + """ + Remove a user registration. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def unregisterUserAsync(self, userid, context=None): + return _M_MumbleServer.Server._op_unregisterUser.invokeAsync(self, ((userid, ), context)) + + """ + Remove a user registration. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_unregisterUser(self, userid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_unregisterUser.begin(self, ((userid, ), _response, _ex, _sent, context)) + + """ + Remove a user registration. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + """ + def end_unregisterUser(self, _r): + return _M_MumbleServer.Server._op_unregisterUser.end(self, _r) + + """ + Update the registration for a user. You can use this to set the email or password of a user, + and can also use it to change the user's name. + Arguments: + userid -- + info -- + context -- The request context for the invocation. + """ + def updateRegistration(self, userid, info, context=None): + return _M_MumbleServer.Server._op_updateRegistration.invoke(self, ((userid, info), context)) + + """ + Update the registration for a user. You can use this to set the email or password of a user, + and can also use it to change the user's name. + Arguments: + userid -- + info -- + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def updateRegistrationAsync(self, userid, info, context=None): + return _M_MumbleServer.Server._op_updateRegistration.invokeAsync(self, ((userid, info), context)) + + """ + Update the registration for a user. You can use this to set the email or password of a user, + and can also use it to change the user's name. + Arguments: + userid -- + info -- + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_updateRegistration(self, userid, info, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_updateRegistration.begin(self, ((userid, info), _response, _ex, _sent, context)) + + """ + Update the registration for a user. You can use this to set the email or password of a user, + and can also use it to change the user's name. + Arguments: + userid -- + info -- + """ + def end_updateRegistration(self, _r): + return _M_MumbleServer.Server._op_updateRegistration.end(self, _r) + + """ + Fetch registration for a single user. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + context -- The request context for the invocation. + Returns: Registration record. + """ + def getRegistration(self, userid, context=None): + return _M_MumbleServer.Server._op_getRegistration.invoke(self, ((userid, ), context)) + + """ + Fetch registration for a single user. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getRegistrationAsync(self, userid, context=None): + return _M_MumbleServer.Server._op_getRegistration.invokeAsync(self, ((userid, ), context)) + + """ + Fetch registration for a single user. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getRegistration(self, userid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getRegistration.begin(self, ((userid, ), _response, _ex, _sent, context)) + + """ + Fetch registration for a single user. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + Returns: Registration record. + """ + def end_getRegistration(self, _r): + return _M_MumbleServer.Server._op_getRegistration.end(self, _r) + + """ + Fetch a group of registered users. + Arguments: + filter -- Substring of user name. If blank, will retrieve all registered users. + context -- The request context for the invocation. + Returns: List of registration records. + """ + def getRegisteredUsers(self, filter, context=None): + return _M_MumbleServer.Server._op_getRegisteredUsers.invoke(self, ((filter, ), context)) + + """ + Fetch a group of registered users. + Arguments: + filter -- Substring of user name. If blank, will retrieve all registered users. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getRegisteredUsersAsync(self, filter, context=None): + return _M_MumbleServer.Server._op_getRegisteredUsers.invokeAsync(self, ((filter, ), context)) + + """ + Fetch a group of registered users. + Arguments: + filter -- Substring of user name. If blank, will retrieve all registered users. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getRegisteredUsers(self, filter, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getRegisteredUsers.begin(self, ((filter, ), _response, _ex, _sent, context)) + + """ + Fetch a group of registered users. + Arguments: + filter -- Substring of user name. If blank, will retrieve all registered users. + Returns: List of registration records. + """ + def end_getRegisteredUsers(self, _r): + return _M_MumbleServer.Server._op_getRegisteredUsers.end(self, _r) + + """ + Verify the password of a user. You can use this to verify a user's credentials. + Arguments: + name -- User name. See RegisteredUser.name. + pw -- User password. + context -- The request context for the invocation. + Returns: User ID of registered user (See RegisteredUser.userid), -1 for failed authentication or -2 for unknown usernames. + """ + def verifyPassword(self, name, pw, context=None): + return _M_MumbleServer.Server._op_verifyPassword.invoke(self, ((name, pw), context)) + + """ + Verify the password of a user. You can use this to verify a user's credentials. + Arguments: + name -- User name. See RegisteredUser.name. + pw -- User password. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def verifyPasswordAsync(self, name, pw, context=None): + return _M_MumbleServer.Server._op_verifyPassword.invokeAsync(self, ((name, pw), context)) + + """ + Verify the password of a user. You can use this to verify a user's credentials. + Arguments: + name -- User name. See RegisteredUser.name. + pw -- User password. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_verifyPassword(self, name, pw, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_verifyPassword.begin(self, ((name, pw), _response, _ex, _sent, context)) + + """ + Verify the password of a user. You can use this to verify a user's credentials. + Arguments: + name -- User name. See RegisteredUser.name. + pw -- User password. + Returns: User ID of registered user (See RegisteredUser.userid), -1 for failed authentication or -2 for unknown usernames. + """ + def end_verifyPassword(self, _r): + return _M_MumbleServer.Server._op_verifyPassword.end(self, _r) + + """ + Fetch user texture. Textures are stored as zlib compress()ed 600x60 32-bit BGRA data. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + context -- The request context for the invocation. + Returns: Custom texture associated with user or an empty texture. + """ + def getTexture(self, userid, context=None): + return _M_MumbleServer.Server._op_getTexture.invoke(self, ((userid, ), context)) + + """ + Fetch user texture. Textures are stored as zlib compress()ed 600x60 32-bit BGRA data. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getTextureAsync(self, userid, context=None): + return _M_MumbleServer.Server._op_getTexture.invokeAsync(self, ((userid, ), context)) + + """ + Fetch user texture. Textures are stored as zlib compress()ed 600x60 32-bit BGRA data. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getTexture(self, userid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getTexture.begin(self, ((userid, ), _response, _ex, _sent, context)) + + """ + Fetch user texture. Textures are stored as zlib compress()ed 600x60 32-bit BGRA data. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + Returns: Custom texture associated with user or an empty texture. + """ + def end_getTexture(self, _r): + return _M_MumbleServer.Server._op_getTexture.end(self, _r) + + """ + Set a user texture (now called avatar). + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + tex -- Texture (as a Byte-Array) to set for the user, or an empty texture to remove the existing texture. + context -- The request context for the invocation. + """ + def setTexture(self, userid, tex, context=None): + return _M_MumbleServer.Server._op_setTexture.invoke(self, ((userid, tex), context)) + + """ + Set a user texture (now called avatar). + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + tex -- Texture (as a Byte-Array) to set for the user, or an empty texture to remove the existing texture. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def setTextureAsync(self, userid, tex, context=None): + return _M_MumbleServer.Server._op_setTexture.invokeAsync(self, ((userid, tex), context)) + + """ + Set a user texture (now called avatar). + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + tex -- Texture (as a Byte-Array) to set for the user, or an empty texture to remove the existing texture. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_setTexture(self, userid, tex, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_setTexture.begin(self, ((userid, tex), _response, _ex, _sent, context)) + + """ + Set a user texture (now called avatar). + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + tex -- Texture (as a Byte-Array) to set for the user, or an empty texture to remove the existing texture. + """ + def end_setTexture(self, _r): + return _M_MumbleServer.Server._op_setTexture.end(self, _r) + + """ + Get virtual server uptime. + Arguments: + context -- The request context for the invocation. + Returns: Uptime of the virtual server in seconds + """ + def getUptime(self, context=None): + return _M_MumbleServer.Server._op_getUptime.invoke(self, ((), context)) + + """ + Get virtual server uptime. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getUptimeAsync(self, context=None): + return _M_MumbleServer.Server._op_getUptime.invokeAsync(self, ((), context)) + + """ + Get virtual server uptime. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getUptime(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getUptime.begin(self, ((), _response, _ex, _sent, context)) + + """ + Get virtual server uptime. + Arguments: + Returns: Uptime of the virtual server in seconds + """ + def end_getUptime(self, _r): + return _M_MumbleServer.Server._op_getUptime.end(self, _r) + + """ + Update the server's certificate information. + Reconfigure the running server's TLS socket with the given + certificate and private key. + The certificate and and private key must be PEM formatted. + New clients will see the new certificate. + Existing clients will continue to see the certificate the server + was using when they connected to it. + This method throws InvalidInputDataException if any of the + following errors happen: + - Unable to decode the PEM certificate and/or private key. + - Unable to decrypt the private key with the given passphrase. + - The certificate and/or private key do not contain RSA keys. + - The certificate is not usable with the given private key. + Arguments: + certificate -- + privateKey -- + passphrase -- + context -- The request context for the invocation. + """ + def updateCertificate(self, certificate, privateKey, passphrase, context=None): + return _M_MumbleServer.Server._op_updateCertificate.invoke(self, ((certificate, privateKey, passphrase), context)) + + """ + Update the server's certificate information. + Reconfigure the running server's TLS socket with the given + certificate and private key. + The certificate and and private key must be PEM formatted. + New clients will see the new certificate. + Existing clients will continue to see the certificate the server + was using when they connected to it. + This method throws InvalidInputDataException if any of the + following errors happen: + - Unable to decode the PEM certificate and/or private key. + - Unable to decrypt the private key with the given passphrase. + - The certificate and/or private key do not contain RSA keys. + - The certificate is not usable with the given private key. + Arguments: + certificate -- + privateKey -- + passphrase -- + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def updateCertificateAsync(self, certificate, privateKey, passphrase, context=None): + return _M_MumbleServer.Server._op_updateCertificate.invokeAsync(self, ((certificate, privateKey, passphrase), context)) + + """ + Update the server's certificate information. + Reconfigure the running server's TLS socket with the given + certificate and private key. + The certificate and and private key must be PEM formatted. + New clients will see the new certificate. + Existing clients will continue to see the certificate the server + was using when they connected to it. + This method throws InvalidInputDataException if any of the + following errors happen: + - Unable to decode the PEM certificate and/or private key. + - Unable to decrypt the private key with the given passphrase. + - The certificate and/or private key do not contain RSA keys. + - The certificate is not usable with the given private key. + Arguments: + certificate -- + privateKey -- + passphrase -- + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_updateCertificate(self, certificate, privateKey, passphrase, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_updateCertificate.begin(self, ((certificate, privateKey, passphrase), _response, _ex, _sent, context)) + + """ + Update the server's certificate information. + Reconfigure the running server's TLS socket with the given + certificate and private key. + The certificate and and private key must be PEM formatted. + New clients will see the new certificate. + Existing clients will continue to see the certificate the server + was using when they connected to it. + This method throws InvalidInputDataException if any of the + following errors happen: + - Unable to decode the PEM certificate and/or private key. + - Unable to decrypt the private key with the given passphrase. + - The certificate and/or private key do not contain RSA keys. + - The certificate is not usable with the given private key. + Arguments: + certificate -- + privateKey -- + passphrase -- + """ + def end_updateCertificate(self, _r): + return _M_MumbleServer.Server._op_updateCertificate.end(self, _r) + + """ + Makes the given user start listening to the given channel. + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + context -- The request context for the invocation. + """ + def startListening(self, userid, channelid, context=None): + return _M_MumbleServer.Server._op_startListening.invoke(self, ((userid, channelid), context)) + + """ + Makes the given user start listening to the given channel. + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def startListeningAsync(self, userid, channelid, context=None): + return _M_MumbleServer.Server._op_startListening.invokeAsync(self, ((userid, channelid), context)) + + """ + Makes the given user start listening to the given channel. + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_startListening(self, userid, channelid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_startListening.begin(self, ((userid, channelid), _response, _ex, _sent, context)) + + """ + Makes the given user start listening to the given channel. + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + """ + def end_startListening(self, _r): + return _M_MumbleServer.Server._op_startListening.end(self, _r) + + """ + Makes the given user stop listening to the given channel. + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + context -- The request context for the invocation. + """ + def stopListening(self, userid, channelid, context=None): + return _M_MumbleServer.Server._op_stopListening.invoke(self, ((userid, channelid), context)) + + """ + Makes the given user stop listening to the given channel. + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def stopListeningAsync(self, userid, channelid, context=None): + return _M_MumbleServer.Server._op_stopListening.invokeAsync(self, ((userid, channelid), context)) + + """ + Makes the given user stop listening to the given channel. + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_stopListening(self, userid, channelid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_stopListening.begin(self, ((userid, channelid), _response, _ex, _sent, context)) + + """ + Makes the given user stop listening to the given channel. + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + """ + def end_stopListening(self, _r): + return _M_MumbleServer.Server._op_stopListening.end(self, _r) + + """ + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + context -- The request context for the invocation. + Returns: Whether the given user is currently listening to the given channel + """ + def isListening(self, userid, channelid, context=None): + return _M_MumbleServer.Server._op_isListening.invoke(self, ((userid, channelid), context)) + + """ + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def isListeningAsync(self, userid, channelid, context=None): + return _M_MumbleServer.Server._op_isListening.invokeAsync(self, ((userid, channelid), context)) + + """ + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_isListening(self, userid, channelid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_isListening.begin(self, ((userid, channelid), _response, _ex, _sent, context)) + + """ + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + Returns: Whether the given user is currently listening to the given channel + """ + def end_isListening(self, _r): + return _M_MumbleServer.Server._op_isListening.end(self, _r) + + """ + Arguments: + userid -- The ID of the user + context -- The request context for the invocation. + Returns: An ID-list of channels the given user is listening to + """ + def getListeningChannels(self, userid, context=None): + return _M_MumbleServer.Server._op_getListeningChannels.invoke(self, ((userid, ), context)) + + """ + Arguments: + userid -- The ID of the user + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getListeningChannelsAsync(self, userid, context=None): + return _M_MumbleServer.Server._op_getListeningChannels.invokeAsync(self, ((userid, ), context)) + + """ + Arguments: + userid -- The ID of the user + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getListeningChannels(self, userid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getListeningChannels.begin(self, ((userid, ), _response, _ex, _sent, context)) + + """ + Arguments: + userid -- The ID of the user + Returns: An ID-list of channels the given user is listening to + """ + def end_getListeningChannels(self, _r): + return _M_MumbleServer.Server._op_getListeningChannels.end(self, _r) + + """ + Arguments: + channelid -- The ID of the channel + context -- The request context for the invocation. + Returns: An ID-list of users listening to the given channel + """ + def getListeningUsers(self, channelid, context=None): + return _M_MumbleServer.Server._op_getListeningUsers.invoke(self, ((channelid, ), context)) + + """ + Arguments: + channelid -- The ID of the channel + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getListeningUsersAsync(self, channelid, context=None): + return _M_MumbleServer.Server._op_getListeningUsers.invokeAsync(self, ((channelid, ), context)) + + """ + Arguments: + channelid -- The ID of the channel + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getListeningUsers(self, channelid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getListeningUsers.begin(self, ((channelid, ), _response, _ex, _sent, context)) + + """ + Arguments: + channelid -- The ID of the channel + Returns: An ID-list of users listening to the given channel + """ + def end_getListeningUsers(self, _r): + return _M_MumbleServer.Server._op_getListeningUsers.end(self, _r) + + """ + Arguments: + channelid -- The ID of the channel + userid -- The ID of the user + context -- The request context for the invocation. + Returns: The volume adjustment set for a listener of the given user in the given channel + """ + def getListenerVolumeAdjustment(self, channelid, userid, context=None): + return _M_MumbleServer.Server._op_getListenerVolumeAdjustment.invoke(self, ((channelid, userid), context)) + + """ + Arguments: + channelid -- The ID of the channel + userid -- The ID of the user + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getListenerVolumeAdjustmentAsync(self, channelid, userid, context=None): + return _M_MumbleServer.Server._op_getListenerVolumeAdjustment.invokeAsync(self, ((channelid, userid), context)) + + """ + Arguments: + channelid -- The ID of the channel + userid -- The ID of the user + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getListenerVolumeAdjustment(self, channelid, userid, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_getListenerVolumeAdjustment.begin(self, ((channelid, userid), _response, _ex, _sent, context)) + + """ + Arguments: + channelid -- The ID of the channel + userid -- The ID of the user + Returns: The volume adjustment set for a listener of the given user in the given channel + """ + def end_getListenerVolumeAdjustment(self, _r): + return _M_MumbleServer.Server._op_getListenerVolumeAdjustment.end(self, _r) + + """ + Sets the volume adjustment set for a listener of the given user in the given channel + Arguments: + channelid -- The ID of the channel + userid -- The ID of the user + volumeAdjustment -- + context -- The request context for the invocation. + """ + def setListenerVolumeAdjustment(self, channelid, userid, volumeAdjustment, context=None): + return _M_MumbleServer.Server._op_setListenerVolumeAdjustment.invoke(self, ((channelid, userid, volumeAdjustment), context)) + + """ + Sets the volume adjustment set for a listener of the given user in the given channel + Arguments: + channelid -- The ID of the channel + userid -- The ID of the user + volumeAdjustment -- + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def setListenerVolumeAdjustmentAsync(self, channelid, userid, volumeAdjustment, context=None): + return _M_MumbleServer.Server._op_setListenerVolumeAdjustment.invokeAsync(self, ((channelid, userid, volumeAdjustment), context)) + + """ + Sets the volume adjustment set for a listener of the given user in the given channel + Arguments: + channelid -- The ID of the channel + userid -- The ID of the user + volumeAdjustment -- + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_setListenerVolumeAdjustment(self, channelid, userid, volumeAdjustment, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_setListenerVolumeAdjustment.begin(self, ((channelid, userid, volumeAdjustment), _response, _ex, _sent, context)) + + """ + Sets the volume adjustment set for a listener of the given user in the given channel + Arguments: + channelid -- The ID of the channel + userid -- The ID of the user + volumeAdjustment -- + """ + def end_setListenerVolumeAdjustment(self, _r): + return _M_MumbleServer.Server._op_setListenerVolumeAdjustment.end(self, _r) + + """ + Arguments: + receiverUserIDs -- list of IDs of the users the message shall be sent to + context -- The request context for the invocation. + """ + def sendWelcomeMessage(self, receiverUserIDs, context=None): + return _M_MumbleServer.Server._op_sendWelcomeMessage.invoke(self, ((receiverUserIDs, ), context)) + + """ + Arguments: + receiverUserIDs -- list of IDs of the users the message shall be sent to + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def sendWelcomeMessageAsync(self, receiverUserIDs, context=None): + return _M_MumbleServer.Server._op_sendWelcomeMessage.invokeAsync(self, ((receiverUserIDs, ), context)) + + """ + Arguments: + receiverUserIDs -- list of IDs of the users the message shall be sent to + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_sendWelcomeMessage(self, receiverUserIDs, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Server._op_sendWelcomeMessage.begin(self, ((receiverUserIDs, ), _response, _ex, _sent, context)) + + def end_sendWelcomeMessage(self, _r): + return _M_MumbleServer.Server._op_sendWelcomeMessage.end(self, _r) + + @staticmethod + def checkedCast(proxy, facetOrContext=None, context=None): + return _M_MumbleServer.ServerPrx.ice_checkedCast(proxy, '::MumbleServer::Server', facetOrContext, context) + + @staticmethod + def uncheckedCast(proxy, facet=None): + return _M_MumbleServer.ServerPrx.ice_uncheckedCast(proxy, facet) + + @staticmethod + def ice_staticId(): + return '::MumbleServer::Server' + _M_MumbleServer._t_ServerPrx = IcePy.defineProxy('::MumbleServer::Server', ServerPrx) + + _M_MumbleServer.ServerPrx = ServerPrx + del ServerPrx + + _M_MumbleServer.Server = Ice.createTempClass() + class Server(Ice.Object): + + def ice_ids(self, current=None): + return ('::Ice::Object', '::MumbleServer::Server') + + def ice_id(self, current=None): + return '::MumbleServer::Server' + + @staticmethod + def ice_staticId(): + return '::MumbleServer::Server' + + def isRunning(self, current=None): + """ + Shows if the server currently running (accepting users). + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'isRunning' not implemented") + + def start(self, current=None): + """ + Start server. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'start' not implemented") + + def stop(self, current=None): + """ + Stop server. + Note: Server will be restarted on Murmur restart unless explicitly disabled + with setConf("boot", false) + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'stop' not implemented") + + def delete(self, current=None): + """ + Delete server and all it's configuration. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'delete' not implemented") + + def id(self, current=None): + """ + Fetch the server id. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'id' not implemented") + + def addCallback(self, cb, current=None): + """ + Add a callback. The callback will receive notifications about changes to users and channels. + Arguments: + cb -- Callback interface which will receive notifications. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'addCallback' not implemented") + + def removeCallback(self, cb, current=None): + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'removeCallback' not implemented") + + def setAuthenticator(self, auth, current=None): + """ + Set external authenticator. If set, all authentications from clients are forwarded to this + proxy. + Arguments: + auth -- Authenticator object to perform subsequent authentications. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'setAuthenticator' not implemented") + + def getConf(self, key, current=None): + """ + Retrieve configuration item. + Arguments: + key -- Configuration key. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getConf' not implemented") + + def getAllConf(self, current=None): + """ + Retrieve all configuration items. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getAllConf' not implemented") + + def setConf(self, key, value, current=None): + """ + Set a configuration item. + Arguments: + key -- Configuration key. + value -- Configuration value. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'setConf' not implemented") + + def setSuperuserPassword(self, pw, current=None): + """ + Set superuser password. This is just a convenience for using updateRegistration on user id 0. + Arguments: + pw -- Password. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'setSuperuserPassword' not implemented") + + def getLog(self, first, last, current=None): + """ + Fetch log entries. + Arguments: + first -- Lowest numbered entry to fetch. 0 is the most recent item. + last -- Last entry to fetch. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getLog' not implemented") + + def getLogLen(self, current=None): + """ + Fetch length of log + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getLogLen' not implemented") + + def getUsers(self, current=None): + """ + Fetch all users. This returns all currently connected users on the server. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getUsers' not implemented") + + def getChannels(self, current=None): + """ + Fetch all channels. This returns all defined channels on the server. The root channel is always channel 0. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getChannels' not implemented") + + def getCertificateList(self, session, current=None): + """ + Fetch certificate of user. This returns the complete certificate chain of a user. + Arguments: + session -- Connection ID of user. See User.session. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getCertificateList' not implemented") + + def getTree(self, current=None): + """ + Fetch all channels and connected users as a tree. This retrieves an easy-to-use representation of the server + as a tree. This is primarily used for viewing the state of the server on a webpage. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getTree' not implemented") + + def getBans(self, current=None): + """ + Fetch all current IP bans on the server. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getBans' not implemented") + + def setBans(self, bans, current=None): + """ + 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 + append to the returned list before calling this method. + Arguments: + bans -- List of bans. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'setBans' not implemented") + + def kickUser(self, session, reason, current=None): + """ + Kick a user. The user is not banned, and is free to rejoin the server. + Arguments: + session -- Connection ID of user. See User.session. + reason -- Text message to show when user is kicked. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'kickUser' not implemented") + + def getState(self, session, current=None): + """ + Get state of a single connected user. + Arguments: + session -- Connection ID of user. See User.session. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getState' not implemented") + + def setState(self, state, current=None): + """ + Set user state. You can use this to move, mute and deafen users. + Arguments: + state -- User state to set. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'setState' not implemented") + + def sendMessage(self, session, text, current=None): + """ + Send text message to a single user. + Arguments: + session -- Connection ID of user. See User.session. + text -- Message to send. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'sendMessage' not implemented") + + def hasPermission(self, session, channelid, perm, current=None): + """ + Check if user is permitted to perform action. + Arguments: + session -- Connection ID of user. See User.session. + channelid -- ID of Channel. See Channel.id. + perm -- Permission bits to check. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'hasPermission' not implemented") + + def effectivePermissions(self, session, channelid, current=None): + """ + Return users effective permissions + Arguments: + session -- Connection ID of user. See User.session. + channelid -- ID of Channel. See Channel.id. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'effectivePermissions' not implemented") + + def addContextCallback(self, session, action, text, cb, ctx, current=None): + """ + Add a context callback. This is done per user, and will add a context menu action for the user. + Arguments: + session -- Session of user which should receive context entry. + action -- Action string, a unique name to associate with the action. + text -- Name of action shown to user. + cb -- Callback interface which will receive notifications. + ctx -- Context this should be used in. Needs to be one or a combination of ContextServer, ContextChannel and ContextUser. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'addContextCallback' not implemented") + + def removeContextCallback(self, cb, current=None): + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. This callback will be removed from all from all users. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'removeContextCallback' not implemented") + + def getChannelState(self, channelid, current=None): + """ + Get state of single channel. + Arguments: + channelid -- ID of Channel. See Channel.id. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getChannelState' not implemented") + + def setChannelState(self, state, current=None): + """ + Set state of a single channel. You can use this to move or relink channels. + Arguments: + state -- Channel state to set. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'setChannelState' not implemented") + + def removeChannel(self, channelid, current=None): + """ + Remove a channel and all its subchannels. + Arguments: + channelid -- ID of Channel. See Channel.id. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'removeChannel' not implemented") + + def addChannel(self, name, parent, current=None): + """ + Add a new channel. + Arguments: + name -- Name of new channel. + parent -- Channel ID of parent channel. See Channel.id. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'addChannel' not implemented") + + def sendMessageChannel(self, channelid, tree, text, current=None): + """ + Send text message to channel or a tree of channels. + Arguments: + channelid -- Channel ID of channel to send to. See Channel.id. + tree -- If true, the message will be sent to the channel and all its subchannels. + text -- Message to send. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'sendMessageChannel' not implemented") + + def getACL(self, channelid, current=None): + """ + Retrieve ACLs and Groups on a channel. + Arguments: + channelid -- Channel ID of channel to fetch from. See Channel.id. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getACL' not implemented") + + def setACL(self, channelid, acls, groups, inherit, current=None): + """ + Set ACLs and Groups on a channel. Note that this will replace all existing ACLs and groups on the channel. + Arguments: + channelid -- Channel ID of channel to fetch from. See Channel.id. + acls -- List of ACLs on the channel. + groups -- List of groups on the channel. + inherit -- Should this channel inherit ACLs from the parent channel? + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'setACL' not implemented") + + def addUserToGroup(self, channelid, session, group, current=None): + """ + Temporarily add a user to a group on a channel. This state is not saved, and is intended for temporary memberships. + Arguments: + channelid -- Channel ID of channel to add to. See Channel.id. + session -- Connection ID of user. See User.session. + group -- Group name to add to. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'addUserToGroup' not implemented") + + def removeUserFromGroup(self, channelid, session, group, current=None): + """ + Remove a user from a temporary group membership on a channel. This state is not saved, and is intended for temporary memberships. + Arguments: + channelid -- Channel ID of channel to add to. See Channel.id. + session -- Connection ID of user. See User.session. + group -- Group name to remove from. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'removeUserFromGroup' not implemented") + + def redirectWhisperGroup(self, session, source, target, current=None): + """ + 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. + Arguments: + session -- Connection ID of user. See User.session. + source -- Group name to redirect from. + target -- Group name to redirect to. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'redirectWhisperGroup' not implemented") + + def getUserNames(self, ids, current=None): + """ + Map a list of User.userid to a matching name. + Arguments: + ids -- + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getUserNames' not implemented") + + def getUserIds(self, names, current=None): + """ + Map a list of user names to a matching id. + @reuturn List of matching ids, with -1 representing invalid or unknown user names. + Arguments: + names -- + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getUserIds' not implemented") + + def registerUser(self, info, current=None): + """ + Register a new user. + Arguments: + info -- Information about new user. Must include at least "name". + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'registerUser' not implemented") + + def unregisterUser(self, userid, current=None): + """ + Remove a user registration. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'unregisterUser' not implemented") + + def updateRegistration(self, userid, info, current=None): + """ + Update the registration for a user. You can use this to set the email or password of a user, + and can also use it to change the user's name. + Arguments: + userid -- + info -- + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'updateRegistration' not implemented") + + def getRegistration(self, userid, current=None): + """ + Fetch registration for a single user. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getRegistration' not implemented") + + def getRegisteredUsers(self, filter, current=None): + """ + Fetch a group of registered users. + Arguments: + filter -- Substring of user name. If blank, will retrieve all registered users. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getRegisteredUsers' not implemented") + + def verifyPassword(self, name, pw, current=None): + """ + Verify the password of a user. You can use this to verify a user's credentials. + Arguments: + name -- User name. See RegisteredUser.name. + pw -- User password. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'verifyPassword' not implemented") + + def getTexture(self, userid, current=None): + """ + Fetch user texture. Textures are stored as zlib compress()ed 600x60 32-bit BGRA data. + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getTexture' not implemented") + + def setTexture(self, userid, tex, current=None): + """ + Set a user texture (now called avatar). + Arguments: + userid -- ID of registered user. See RegisteredUser.userid. + tex -- Texture (as a Byte-Array) to set for the user, or an empty texture to remove the existing texture. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'setTexture' not implemented") + + def getUptime(self, current=None): + """ + Get virtual server uptime. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getUptime' not implemented") + + def updateCertificate(self, certificate, privateKey, passphrase, current=None): + """ + Update the server's certificate information. + Reconfigure the running server's TLS socket with the given + certificate and private key. + The certificate and and private key must be PEM formatted. + New clients will see the new certificate. + Existing clients will continue to see the certificate the server + was using when they connected to it. + This method throws InvalidInputDataException if any of the + following errors happen: + - Unable to decode the PEM certificate and/or private key. + - Unable to decrypt the private key with the given passphrase. + - The certificate and/or private key do not contain RSA keys. + - The certificate is not usable with the given private key. + Arguments: + certificate -- + privateKey -- + passphrase -- + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'updateCertificate' not implemented") + + def startListening(self, userid, channelid, current=None): + """ + Makes the given user start listening to the given channel. + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'startListening' not implemented") + + def stopListening(self, userid, channelid, current=None): + """ + Makes the given user stop listening to the given channel. + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'stopListening' not implemented") + + def isListening(self, userid, channelid, current=None): + """ + Arguments: + userid -- The ID of the user + channelid -- The ID of the channel + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'isListening' not implemented") + + def getListeningChannels(self, userid, current=None): + """ + Arguments: + userid -- The ID of the user + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getListeningChannels' not implemented") + + def getListeningUsers(self, channelid, current=None): + """ + Arguments: + channelid -- The ID of the channel + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getListeningUsers' not implemented") + + def getListenerVolumeAdjustment(self, channelid, userid, current=None): + """ + Arguments: + channelid -- The ID of the channel + userid -- The ID of the user + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getListenerVolumeAdjustment' not implemented") + + def setListenerVolumeAdjustment(self, channelid, userid, volumeAdjustment, current=None): + """ + Sets the volume adjustment set for a listener of the given user in the given channel + Arguments: + channelid -- The ID of the channel + userid -- The ID of the user + volumeAdjustment -- + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'setListenerVolumeAdjustment' not implemented") + + def sendWelcomeMessage(self, receiverUserIDs, current=None): + """ + Arguments: + receiverUserIDs -- list of IDs of the users the message shall be sent to + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'sendWelcomeMessage' not implemented") + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_ServerDisp) + + __repr__ = __str__ + + _M_MumbleServer._t_ServerDisp = IcePy.defineClass('::MumbleServer::Server', Server, (), None, ()) + Server._ice_type = _M_MumbleServer._t_ServerDisp + + Server._op_isRunning = IcePy.Operation('isRunning', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), IcePy._t_bool, False, 0), (_M_MumbleServer._t_InvalidSecretException,)) + Server._op_start = IcePy.Operation('start', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_ServerFailureException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_stop = IcePy.Operation('stop', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_delete = IcePy.Operation('delete', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_id = IcePy.Operation('id', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), IcePy._t_int, False, 0), (_M_MumbleServer._t_InvalidSecretException,)) + Server._op_addCallback = IcePy.Operation('addCallback', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), _M_MumbleServer._t_ServerCallbackPrx, False, 0),), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidCallbackException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_removeCallback = IcePy.Operation('removeCallback', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), _M_MumbleServer._t_ServerCallbackPrx, False, 0),), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidCallbackException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_setAuthenticator = IcePy.Operation('setAuthenticator', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), _M_MumbleServer._t_ServerAuthenticatorPrx, False, 0),), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidCallbackException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getConf = IcePy.Operation('getConf', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_string, False, 0),), (), ((), IcePy._t_string, False, 0), (_M_MumbleServer._t_InvalidSecretException, _M_MumbleServer._t_WriteOnlyException)) + Server._op_getAllConf = IcePy.Operation('getAllConf', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), _M_MumbleServer._t_ConfigMap, False, 0), (_M_MumbleServer._t_InvalidSecretException,)) + Server._op_setConf = IcePy.Operation('setConf', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0)), (), None, (_M_MumbleServer._t_InvalidSecretException,)) + Server._op_setSuperuserPassword = IcePy.Operation('setSuperuserPassword', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_string, False, 0),), (), None, (_M_MumbleServer._t_InvalidSecretException,)) + Server._op_getLog = IcePy.Operation('getLog', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), (), ((), _M_MumbleServer._t_LogList, False, 0), (_M_MumbleServer._t_InvalidSecretException,)) + Server._op_getLogLen = IcePy.Operation('getLogLen', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), IcePy._t_int, False, 0), (_M_MumbleServer._t_InvalidSecretException,)) + Server._op_getUsers = IcePy.Operation('getUsers', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), _M_MumbleServer._t_UserMap, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getChannels = IcePy.Operation('getChannels', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), _M_MumbleServer._t_ChannelMap, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getCertificateList = IcePy.Operation('getCertificateList', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0),), (), ((), _M_MumbleServer._t_CertificateList, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSessionException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getTree = IcePy.Operation('getTree', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), _M_MumbleServer._t_Tree, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getBans = IcePy.Operation('getBans', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), _M_MumbleServer._t_BanList, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_setBans = IcePy.Operation('setBans', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), _M_MumbleServer._t_BanList, False, 0),), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_kickUser = IcePy.Operation('kickUser', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0)), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSessionException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getState = IcePy.Operation('getState', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0),), (), ((), _M_MumbleServer._t_User, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSessionException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_setState = IcePy.Operation('setState', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), _M_MumbleServer._t_User, False, 0),), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSessionException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_sendMessage = IcePy.Operation('sendMessage', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0)), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSessionException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_hasPermission = IcePy.Operation('hasPermission', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), (), ((), IcePy._t_bool, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSessionException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_effectivePermissions = IcePy.Operation('effectivePermissions', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), (), ((), IcePy._t_int, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSessionException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_addContextCallback = IcePy.Operation('addContextCallback', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0), ((), _M_MumbleServer._t_ServerContextCallbackPrx, False, 0), ((), IcePy._t_int, False, 0)), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidCallbackException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_removeContextCallback = IcePy.Operation('removeContextCallback', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), _M_MumbleServer._t_ServerContextCallbackPrx, False, 0),), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidCallbackException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getChannelState = IcePy.Operation('getChannelState', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0),), (), ((), _M_MumbleServer._t_Channel, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_setChannelState = IcePy.Operation('setChannelState', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), _M_MumbleServer._t_Channel, False, 0),), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSecretException, _M_MumbleServer._t_NestingLimitException)) + Server._op_removeChannel = IcePy.Operation('removeChannel', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), IcePy._t_int, False, 0),), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_addChannel = IcePy.Operation('addChannel', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), IcePy._t_string, False, 0), ((), IcePy._t_int, False, 0)), (), ((), IcePy._t_int, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSecretException, _M_MumbleServer._t_NestingLimitException)) + Server._op_sendMessageChannel = IcePy.Operation('sendMessageChannel', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_bool, False, 0), ((), IcePy._t_string, False, 0)), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getACL = IcePy.Operation('getACL', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0),), (((), _M_MumbleServer._t_ACLList, False, 0), ((), _M_MumbleServer._t_GroupList, False, 0), ((), IcePy._t_bool, False, 0)), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_setACL = IcePy.Operation('setACL', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), _M_MumbleServer._t_ACLList, False, 0), ((), _M_MumbleServer._t_GroupList, False, 0), ((), IcePy._t_bool, False, 0)), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_addUserToGroup = IcePy.Operation('addUserToGroup', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0)), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSessionException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_removeUserFromGroup = IcePy.Operation('removeUserFromGroup', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0)), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidChannelException, _M_MumbleServer._t_InvalidSessionException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_redirectWhisperGroup = IcePy.Operation('redirectWhisperGroup', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0)), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSessionException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getUserNames = IcePy.Operation('getUserNames', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), _M_MumbleServer._t_IdList, False, 0),), (), ((), _M_MumbleServer._t_NameMap, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getUserIds = IcePy.Operation('getUserIds', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), _M_MumbleServer._t_NameList, False, 0),), (), ((), _M_MumbleServer._t_IdMap, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_registerUser = IcePy.Operation('registerUser', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), _M_MumbleServer._t_UserInfoMap, False, 0),), (), ((), IcePy._t_int, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidUserException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_unregisterUser = IcePy.Operation('unregisterUser', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), IcePy._t_int, False, 0),), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidUserException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_updateRegistration = IcePy.Operation('updateRegistration', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), _M_MumbleServer._t_UserInfoMap, False, 0)), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidUserException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getRegistration = IcePy.Operation('getRegistration', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0),), (), ((), _M_MumbleServer._t_UserInfoMap, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidUserException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getRegisteredUsers = IcePy.Operation('getRegisteredUsers', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_string, False, 0),), (), ((), _M_MumbleServer._t_NameMap, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_verifyPassword = IcePy.Operation('verifyPassword', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0)), (), ((), IcePy._t_int, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getTexture = IcePy.Operation('getTexture', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0),), (), ((), _M_MumbleServer._t_Texture, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidUserException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_setTexture = IcePy.Operation('setTexture', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), _M_MumbleServer._t_Texture, False, 0)), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidUserException, _M_MumbleServer._t_InvalidTextureException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_getUptime = IcePy.Operation('getUptime', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), IcePy._t_int, False, 0), (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException)) + Server._op_updateCertificate = IcePy.Operation('updateCertificate', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0), ((), IcePy._t_string, False, 0)), (), None, (_M_MumbleServer._t_ServerBootedException, _M_MumbleServer._t_InvalidSecretException, _M_MumbleServer._t_InvalidInputDataException)) + Server._op_startListening = IcePy.Operation('startListening', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), (), None, ()) + Server._op_stopListening = IcePy.Operation('stopListening', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), (), None, ()) + Server._op_isListening = IcePy.Operation('isListening', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), (), ((), IcePy._t_bool, False, 0), ()) + Server._op_getListeningChannels = IcePy.Operation('getListeningChannels', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0),), (), ((), _M_MumbleServer._t_IntList, False, 0), ()) + Server._op_getListeningUsers = IcePy.Operation('getListeningUsers', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0),), (), ((), _M_MumbleServer._t_IntList, False, 0), ()) + Server._op_getListenerVolumeAdjustment = IcePy.Operation('getListenerVolumeAdjustment', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0)), (), ((), IcePy._t_float, False, 0), ()) + Server._op_setListenerVolumeAdjustment = IcePy.Operation('setListenerVolumeAdjustment', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_float, False, 0)), (), None, ()) + Server._op_sendWelcomeMessage = IcePy.Operation('sendWelcomeMessage', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), _M_MumbleServer._t_IdList, False, 0),), (), None, ()) + + _M_MumbleServer.Server = Server + del Server + +_M_MumbleServer._t_MetaCallback = IcePy.defineValue('::MumbleServer::MetaCallback', Ice.Value, -1, (), False, True, None, ()) + +if 'MetaCallbackPrx' not in _M_MumbleServer.__dict__: + _M_MumbleServer.MetaCallbackPrx = Ice.createTempClass() + class MetaCallbackPrx(Ice.ObjectPrx): + + """ + Called when a server is started. The server is up and running when this event is sent, so all methods that + need a running server will work. + Arguments: + srv -- Interface for started server. + context -- The request context for the invocation. + """ + def started(self, srv, context=None): + return _M_MumbleServer.MetaCallback._op_started.invoke(self, ((srv, ), context)) + + """ + Called when a server is started. The server is up and running when this event is sent, so all methods that + need a running server will work. + Arguments: + srv -- Interface for started server. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def startedAsync(self, srv, context=None): + return _M_MumbleServer.MetaCallback._op_started.invokeAsync(self, ((srv, ), context)) + + """ + Called when a server is started. The server is up and running when this event is sent, so all methods that + need a running server will work. + Arguments: + srv -- Interface for started server. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_started(self, srv, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.MetaCallback._op_started.begin(self, ((srv, ), _response, _ex, _sent, context)) + + """ + Called when a server is started. The server is up and running when this event is sent, so all methods that + need a running server will work. + Arguments: + srv -- Interface for started server. + """ + def end_started(self, _r): + return _M_MumbleServer.MetaCallback._op_started.end(self, _r) + + """ + Called when a server is stopped. The server is already stopped when this event is sent, so no methods that + need a running server will work. + Arguments: + srv -- Interface for started server. + context -- The request context for the invocation. + """ + def stopped(self, srv, context=None): + return _M_MumbleServer.MetaCallback._op_stopped.invoke(self, ((srv, ), context)) + + """ + Called when a server is stopped. The server is already stopped when this event is sent, so no methods that + need a running server will work. + Arguments: + srv -- Interface for started server. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def stoppedAsync(self, srv, context=None): + return _M_MumbleServer.MetaCallback._op_stopped.invokeAsync(self, ((srv, ), context)) + + """ + Called when a server is stopped. The server is already stopped when this event is sent, so no methods that + need a running server will work. + Arguments: + srv -- Interface for started server. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_stopped(self, srv, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.MetaCallback._op_stopped.begin(self, ((srv, ), _response, _ex, _sent, context)) + + """ + Called when a server is stopped. The server is already stopped when this event is sent, so no methods that + need a running server will work. + Arguments: + srv -- Interface for started server. + """ + def end_stopped(self, _r): + return _M_MumbleServer.MetaCallback._op_stopped.end(self, _r) + + @staticmethod + def checkedCast(proxy, facetOrContext=None, context=None): + return _M_MumbleServer.MetaCallbackPrx.ice_checkedCast(proxy, '::MumbleServer::MetaCallback', facetOrContext, context) + + @staticmethod + def uncheckedCast(proxy, facet=None): + return _M_MumbleServer.MetaCallbackPrx.ice_uncheckedCast(proxy, facet) + + @staticmethod + def ice_staticId(): + return '::MumbleServer::MetaCallback' + _M_MumbleServer._t_MetaCallbackPrx = IcePy.defineProxy('::MumbleServer::MetaCallback', MetaCallbackPrx) + + _M_MumbleServer.MetaCallbackPrx = MetaCallbackPrx + del MetaCallbackPrx + + _M_MumbleServer.MetaCallback = Ice.createTempClass() + class MetaCallback(Ice.Object): + + def ice_ids(self, current=None): + return ('::Ice::Object', '::MumbleServer::MetaCallback') + + def ice_id(self, current=None): + return '::MumbleServer::MetaCallback' + + @staticmethod + def ice_staticId(): + return '::MumbleServer::MetaCallback' + + def started(self, srv, current=None): + """ + Called when a server is started. The server is up and running when this event is sent, so all methods that + need a running server will work. + Arguments: + srv -- Interface for started server. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'started' not implemented") + + def stopped(self, srv, current=None): + """ + Called when a server is stopped. The server is already stopped when this event is sent, so no methods that + need a running server will work. + Arguments: + srv -- Interface for started server. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'stopped' not implemented") + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_MetaCallbackDisp) + + __repr__ = __str__ + + _M_MumbleServer._t_MetaCallbackDisp = IcePy.defineClass('::MumbleServer::MetaCallback', MetaCallback, (), None, ()) + MetaCallback._ice_type = _M_MumbleServer._t_MetaCallbackDisp + + MetaCallback._op_started = IcePy.Operation('started', Ice.OperationMode.Normal, Ice.OperationMode.Normal, False, None, (), (((), _M_MumbleServer._t_ServerPrx, False, 0),), (), None, ()) + MetaCallback._op_stopped = IcePy.Operation('stopped', Ice.OperationMode.Normal, Ice.OperationMode.Normal, False, None, (), (((), _M_MumbleServer._t_ServerPrx, False, 0),), (), None, ()) + + _M_MumbleServer.MetaCallback = MetaCallback + del MetaCallback + +if '_t_ServerList' not in _M_MumbleServer.__dict__: + _M_MumbleServer._t_ServerList = IcePy.defineSequence('::MumbleServer::ServerList', (), _M_MumbleServer._t_ServerPrx) + +_M_MumbleServer._t_Meta = IcePy.defineValue('::MumbleServer::Meta', Ice.Value, -1, (), False, True, None, ()) + +if 'MetaPrx' not in _M_MumbleServer.__dict__: + _M_MumbleServer.MetaPrx = Ice.createTempClass() + class MetaPrx(Ice.ObjectPrx): + + """ + Fetch interface to specific server. + Arguments: + id -- Server ID. See Server.getId. + context -- The request context for the invocation. + Returns: Interface for specified server, or a null proxy if id is invalid. + """ + def getServer(self, id, context=None): + return _M_MumbleServer.Meta._op_getServer.invoke(self, ((id, ), context)) + + """ + Fetch interface to specific server. + Arguments: + id -- Server ID. See Server.getId. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getServerAsync(self, id, context=None): + return _M_MumbleServer.Meta._op_getServer.invokeAsync(self, ((id, ), context)) + + """ + Fetch interface to specific server. + Arguments: + id -- Server ID. See Server.getId. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getServer(self, id, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Meta._op_getServer.begin(self, ((id, ), _response, _ex, _sent, context)) + + """ + Fetch interface to specific server. + Arguments: + id -- Server ID. See Server.getId. + Returns: Interface for specified server, or a null proxy if id is invalid. + """ + def end_getServer(self, _r): + return _M_MumbleServer.Meta._op_getServer.end(self, _r) + + """ + Create a new server. Call Server.getId on the returned interface to find it's ID. + Arguments: + context -- The request context for the invocation. + Returns: Interface for new server. + """ + def newServer(self, context=None): + return _M_MumbleServer.Meta._op_newServer.invoke(self, ((), context)) + + """ + Create a new server. Call Server.getId on the returned interface to find it's ID. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def newServerAsync(self, context=None): + return _M_MumbleServer.Meta._op_newServer.invokeAsync(self, ((), context)) + + """ + Create a new server. Call Server.getId on the returned interface to find it's ID. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_newServer(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Meta._op_newServer.begin(self, ((), _response, _ex, _sent, context)) + + """ + Create a new server. Call Server.getId on the returned interface to find it's ID. + Arguments: + Returns: Interface for new server. + """ + def end_newServer(self, _r): + return _M_MumbleServer.Meta._op_newServer.end(self, _r) + + """ + Fetch list of all currently running servers. + Arguments: + context -- The request context for the invocation. + Returns: List of interfaces for running servers. + """ + def getBootedServers(self, context=None): + return _M_MumbleServer.Meta._op_getBootedServers.invoke(self, ((), context)) + + """ + Fetch list of all currently running servers. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getBootedServersAsync(self, context=None): + return _M_MumbleServer.Meta._op_getBootedServers.invokeAsync(self, ((), context)) + + """ + Fetch list of all currently running servers. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getBootedServers(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Meta._op_getBootedServers.begin(self, ((), _response, _ex, _sent, context)) + + """ + Fetch list of all currently running servers. + Arguments: + Returns: List of interfaces for running servers. + """ + def end_getBootedServers(self, _r): + return _M_MumbleServer.Meta._op_getBootedServers.end(self, _r) + + """ + Fetch list of all defined servers. + Arguments: + context -- The request context for the invocation. + Returns: List of interfaces for all servers. + """ + def getAllServers(self, context=None): + return _M_MumbleServer.Meta._op_getAllServers.invoke(self, ((), context)) + + """ + Fetch list of all defined servers. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getAllServersAsync(self, context=None): + return _M_MumbleServer.Meta._op_getAllServers.invokeAsync(self, ((), context)) + + """ + Fetch list of all defined servers. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getAllServers(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Meta._op_getAllServers.begin(self, ((), _response, _ex, _sent, context)) + + """ + Fetch list of all defined servers. + Arguments: + Returns: List of interfaces for all servers. + """ + def end_getAllServers(self, _r): + return _M_MumbleServer.Meta._op_getAllServers.end(self, _r) + + """ + Fetch default configuration. This returns the configuration items that were set in the configuration file, or + the built-in default. The individual servers will use these values unless they have been overridden in the + server specific configuration. The only special case is the port, which defaults to the value defined here + + the servers ID - 1 (so that virtual server #1 uses the defined port, server #2 uses port+1 etc). + Arguments: + context -- The request context for the invocation. + Returns: Default configuration of the servers. + """ + def getDefaultConf(self, context=None): + return _M_MumbleServer.Meta._op_getDefaultConf.invoke(self, ((), context)) + + """ + Fetch default configuration. This returns the configuration items that were set in the configuration file, or + the built-in default. The individual servers will use these values unless they have been overridden in the + server specific configuration. The only special case is the port, which defaults to the value defined here + + the servers ID - 1 (so that virtual server #1 uses the defined port, server #2 uses port+1 etc). + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getDefaultConfAsync(self, context=None): + return _M_MumbleServer.Meta._op_getDefaultConf.invokeAsync(self, ((), context)) + + """ + Fetch default configuration. This returns the configuration items that were set in the configuration file, or + the built-in default. The individual servers will use these values unless they have been overridden in the + server specific configuration. The only special case is the port, which defaults to the value defined here + + the servers ID - 1 (so that virtual server #1 uses the defined port, server #2 uses port+1 etc). + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getDefaultConf(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Meta._op_getDefaultConf.begin(self, ((), _response, _ex, _sent, context)) + + """ + Fetch default configuration. This returns the configuration items that were set in the configuration file, or + the built-in default. The individual servers will use these values unless they have been overridden in the + server specific configuration. The only special case is the port, which defaults to the value defined here + + the servers ID - 1 (so that virtual server #1 uses the defined port, server #2 uses port+1 etc). + Arguments: + Returns: Default configuration of the servers. + """ + def end_getDefaultConf(self, _r): + return _M_MumbleServer.Meta._op_getDefaultConf.end(self, _r) + + """ + Fetch version of Murmur. + Arguments: + context -- The request context for the invocation. + Returns a tuple containing the following: + major -- Major version. + minor -- Minor version. + patch -- Patchlevel. + text -- Textual representation of version. Note that this may not match the major, minor and 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. + """ + def getVersion(self, context=None): + return _M_MumbleServer.Meta._op_getVersion.invoke(self, ((), context)) + + """ + Fetch version of Murmur. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getVersionAsync(self, context=None): + return _M_MumbleServer.Meta._op_getVersion.invokeAsync(self, ((), context)) + + """ + Fetch version of Murmur. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getVersion(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Meta._op_getVersion.begin(self, ((), _response, _ex, _sent, context)) + + """ + Fetch version of Murmur. + Arguments: + Returns a tuple containing the following: + major -- Major version. + minor -- Minor version. + patch -- Patchlevel. + text -- Textual representation of version. Note that this may not match the major, minor and 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. + """ + def end_getVersion(self, _r): + return _M_MumbleServer.Meta._op_getVersion.end(self, _r) + + """ + Add a callback. The callback will receive notifications when servers are started or stopped. + Arguments: + cb -- Callback interface which will receive notifications. + context -- The request context for the invocation. + """ + def addCallback(self, cb, context=None): + return _M_MumbleServer.Meta._op_addCallback.invoke(self, ((cb, ), context)) + + """ + Add a callback. The callback will receive notifications when servers are started or stopped. + Arguments: + cb -- Callback interface which will receive notifications. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def addCallbackAsync(self, cb, context=None): + return _M_MumbleServer.Meta._op_addCallback.invokeAsync(self, ((cb, ), context)) + + """ + Add a callback. The callback will receive notifications when servers are started or stopped. + Arguments: + cb -- Callback interface which will receive notifications. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_addCallback(self, cb, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Meta._op_addCallback.begin(self, ((cb, ), _response, _ex, _sent, context)) + + """ + Add a callback. The callback will receive notifications when servers are started or stopped. + Arguments: + cb -- Callback interface which will receive notifications. + """ + def end_addCallback(self, _r): + return _M_MumbleServer.Meta._op_addCallback.end(self, _r) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. + context -- The request context for the invocation. + """ + def removeCallback(self, cb, context=None): + return _M_MumbleServer.Meta._op_removeCallback.invoke(self, ((cb, ), context)) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def removeCallbackAsync(self, cb, context=None): + return _M_MumbleServer.Meta._op_removeCallback.invokeAsync(self, ((cb, ), context)) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_removeCallback(self, cb, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Meta._op_removeCallback.begin(self, ((cb, ), _response, _ex, _sent, context)) + + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. + """ + def end_removeCallback(self, _r): + return _M_MumbleServer.Meta._op_removeCallback.end(self, _r) + + """ + Get murmur uptime. + Arguments: + context -- The request context for the invocation. + Returns: Uptime of murmur in seconds + """ + def getUptime(self, context=None): + return _M_MumbleServer.Meta._op_getUptime.invoke(self, ((), context)) + + """ + Get murmur uptime. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getUptimeAsync(self, context=None): + return _M_MumbleServer.Meta._op_getUptime.invokeAsync(self, ((), context)) + + """ + Get murmur uptime. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getUptime(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Meta._op_getUptime.begin(self, ((), _response, _ex, _sent, context)) + + """ + Get murmur uptime. + Arguments: + Returns: Uptime of murmur in seconds + """ + def end_getUptime(self, _r): + return _M_MumbleServer.Meta._op_getUptime.end(self, _r) + + """ + Get slice file. + Arguments: + context -- The request context for the invocation. + Returns: Contents of the slice file server compiled with. + """ + def getSlice(self, context=None): + return _M_MumbleServer.Meta._op_getSlice.invoke(self, ((), context)) + + """ + Get slice file. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getSliceAsync(self, context=None): + return _M_MumbleServer.Meta._op_getSlice.invokeAsync(self, ((), context)) + + """ + Get slice file. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getSlice(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Meta._op_getSlice.begin(self, ((), _response, _ex, _sent, context)) + + """ + Get slice file. + Arguments: + Returns: Contents of the slice file server compiled with. + """ + def end_getSlice(self, _r): + return _M_MumbleServer.Meta._op_getSlice.end(self, _r) + + """ + Returns a checksum dict for the slice file. + Arguments: + context -- The request context for the invocation. + Returns: Checksum dict + """ + def getSliceChecksums(self, context=None): + return _M_MumbleServer.Meta._op_getSliceChecksums.invoke(self, ((), context)) + + """ + Returns a checksum dict for the slice file. + Arguments: + context -- The request context for the invocation. + Returns: A future object for the invocation. + """ + def getSliceChecksumsAsync(self, context=None): + return _M_MumbleServer.Meta._op_getSliceChecksums.invokeAsync(self, ((), context)) + + """ + Returns a checksum dict for the slice file. + Arguments: + _response -- The asynchronous response callback. + _ex -- The asynchronous exception callback. + _sent -- The asynchronous sent callback. + context -- The request context for the invocation. + Returns: An asynchronous result object for the invocation. + """ + def begin_getSliceChecksums(self, _response=None, _ex=None, _sent=None, context=None): + return _M_MumbleServer.Meta._op_getSliceChecksums.begin(self, ((), _response, _ex, _sent, context)) + + """ + Returns a checksum dict for the slice file. + Arguments: + Returns: Checksum dict + """ + def end_getSliceChecksums(self, _r): + return _M_MumbleServer.Meta._op_getSliceChecksums.end(self, _r) + + @staticmethod + def checkedCast(proxy, facetOrContext=None, context=None): + return _M_MumbleServer.MetaPrx.ice_checkedCast(proxy, '::MumbleServer::Meta', facetOrContext, context) + + @staticmethod + def uncheckedCast(proxy, facet=None): + return _M_MumbleServer.MetaPrx.ice_uncheckedCast(proxy, facet) + + @staticmethod + def ice_staticId(): + return '::MumbleServer::Meta' + _M_MumbleServer._t_MetaPrx = IcePy.defineProxy('::MumbleServer::Meta', MetaPrx) + + _M_MumbleServer.MetaPrx = MetaPrx + del MetaPrx + + _M_MumbleServer.Meta = Ice.createTempClass() + class Meta(Ice.Object): + + def ice_ids(self, current=None): + return ('::Ice::Object', '::MumbleServer::Meta') + + def ice_id(self, current=None): + return '::MumbleServer::Meta' + + @staticmethod + def ice_staticId(): + return '::MumbleServer::Meta' + + def getServer(self, id, current=None): + """ + Fetch interface to specific server. + Arguments: + id -- Server ID. See Server.getId. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getServer' not implemented") + + def newServer(self, current=None): + """ + Create a new server. Call Server.getId on the returned interface to find it's ID. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'newServer' not implemented") + + def getBootedServers(self, current=None): + """ + Fetch list of all currently running servers. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getBootedServers' not implemented") + + def getAllServers(self, current=None): + """ + Fetch list of all defined servers. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getAllServers' not implemented") + + def getDefaultConf(self, current=None): + """ + Fetch default configuration. This returns the configuration items that were set in the configuration file, or + the built-in default. The individual servers will use these values unless they have been overridden in the + server specific configuration. The only special case is the port, which defaults to the value defined here + + the servers ID - 1 (so that virtual server #1 uses the defined port, server #2 uses port+1 etc). + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getDefaultConf' not implemented") + + def getVersion(self, current=None): + """ + Fetch version of Murmur. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getVersion' not implemented") + + def addCallback(self, cb, current=None): + """ + Add a callback. The callback will receive notifications when servers are started or stopped. + Arguments: + cb -- Callback interface which will receive notifications. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'addCallback' not implemented") + + def removeCallback(self, cb, current=None): + """ + Remove a callback. + Arguments: + cb -- Callback interface to be removed. + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'removeCallback' not implemented") + + def getUptime(self, current=None): + """ + Get murmur uptime. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getUptime' not implemented") + + def getSlice(self, current=None): + """ + Get slice file. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getSlice' not implemented") + + def getSliceChecksums(self, current=None): + """ + Returns a checksum dict for the slice file. + Arguments: + current -- The Current object for the invocation. + Returns: A future object for the invocation. + """ + raise NotImplementedError("servant method 'getSliceChecksums' not implemented") + + def __str__(self): + return IcePy.stringify(self, _M_MumbleServer._t_MetaDisp) + + __repr__ = __str__ + + _M_MumbleServer._t_MetaDisp = IcePy.defineClass('::MumbleServer::Meta', Meta, (), None, ()) + Meta._ice_type = _M_MumbleServer._t_MetaDisp + + Meta._op_getServer = IcePy.Operation('getServer', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (((), IcePy._t_int, False, 0),), (), ((), _M_MumbleServer._t_ServerPrx, False, 0), (_M_MumbleServer._t_InvalidSecretException,)) + Meta._op_newServer = IcePy.Operation('newServer', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (), (), ((), _M_MumbleServer._t_ServerPrx, False, 0), (_M_MumbleServer._t_InvalidSecretException,)) + Meta._op_getBootedServers = IcePy.Operation('getBootedServers', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), _M_MumbleServer._t_ServerList, False, 0), (_M_MumbleServer._t_InvalidSecretException,)) + Meta._op_getAllServers = IcePy.Operation('getAllServers', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), _M_MumbleServer._t_ServerList, False, 0), (_M_MumbleServer._t_InvalidSecretException,)) + Meta._op_getDefaultConf = IcePy.Operation('getDefaultConf', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), _M_MumbleServer._t_ConfigMap, False, 0), (_M_MumbleServer._t_InvalidSecretException,)) + Meta._op_getVersion = IcePy.Operation('getVersion', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_int, False, 0), ((), IcePy._t_string, False, 0)), None, ()) + Meta._op_addCallback = IcePy.Operation('addCallback', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), _M_MumbleServer._t_MetaCallbackPrx, False, 0),), (), None, (_M_MumbleServer._t_InvalidCallbackException, _M_MumbleServer._t_InvalidSecretException)) + Meta._op_removeCallback = IcePy.Operation('removeCallback', Ice.OperationMode.Normal, Ice.OperationMode.Normal, True, None, (), (((), _M_MumbleServer._t_MetaCallbackPrx, False, 0),), (), None, (_M_MumbleServer._t_InvalidCallbackException, _M_MumbleServer._t_InvalidSecretException)) + Meta._op_getUptime = IcePy.Operation('getUptime', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), IcePy._t_int, False, 0), ()) + Meta._op_getSlice = IcePy.Operation('getSlice', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), IcePy._t_string, False, 0), ()) + Meta._op_getSliceChecksums = IcePy.Operation('getSliceChecksums', Ice.OperationMode.Idempotent, Ice.OperationMode.Idempotent, True, None, (), (), (), ((), _M_Ice._t_SliceChecksumDict, False, 0), ()) + + _M_MumbleServer.Meta = Meta + del Meta + +# End of module MumbleServer diff --git a/__pycache__/Mumble_pb2.cpython-312.pyc b/__pycache__/Mumble_pb2.cpython-312.pyc deleted file mode 100644 index aec0344..0000000 Binary files a/__pycache__/Mumble_pb2.cpython-312.pyc and /dev/null differ diff --git a/audioKiller.py b/audioKiller.py new file mode 100644 index 0000000..910a611 --- /dev/null +++ b/audioKiller.py @@ -0,0 +1,40 @@ +import struct +REMEMBER_ME = "<4sI4s4sIHHIIHH4sI" +def read_wav_header(filename): + with open(filename, "r+b") as f: + # Standard PCM WAV header is typically 44 bytes + f.seek(0) + f.write(b"RIFF") + header = f.read(44) + + # Unpack the header according to the RIFF/WAV format + # < : little-endian + # 4s : 4-byte string + # I : unsigned 32-bit integer + # H : unsigned 16-bit integer + fields = struct.unpack("<4sI4s4sIHHIIHH4sI", header) + + wav_info = { + "chunk_id": fields[0].decode(), # RIFF + "chunk_size": fields[1], # File size - 8 + "format": fields[2].decode(), # WAVE + "subchunk1_id": fields[3].decode(), # fmt + "subchunk1_size": fields[4], # Usually 16 for PCM + "audio_format": fields[5], # 1 = PCM + "num_channels": fields[6], # 1 = mono, 2 = stereo + "sample_rate": fields[7], # e.g. 48000 + "byte_rate": fields[8], # sample_rate * channels * bits/8 + "block_align": fields[9], # channels * bits/8 + "bits_per_sample":fields[10], # 16, 24, 32 + "subchunk2_id": fields[11].decode(), # data + "subchunk2_size": fields[12], # Number of bytes of PCM data + } + + return wav_info + + +# Example usage +info = read_wav_header("sample-speech-5m.wav") + +for key, value in info.items(): + print(f"{key}: {value}") \ No newline at end of file diff --git a/mumble_server_config.py b/mumble_server_config.py new file mode 100644 index 0000000..2b0ccec --- /dev/null +++ b/mumble_server_config.py @@ -0,0 +1,230 @@ + +# NOTE: + + +import base64 +import io +import shlex +from datetime import datetime + +import paramiko +import yaml + +# Servers to update +SERVERS = [ + "172.16.10.123", + "172.16.10.110", + "172.16.10.107", +] + +# SSH configuration +USERNAME = "cezen" +PASSWORD = "17lamborghini" +REMOTE_YAML = "/home/cezen/Desktop/mumble-server/docker-compose.yml" +BACKUP_YAML = REMOTE_YAML + ".bak" +VERSION_DIR = "/home/cezen/Desktop/mumble-server/config_versions" +VERSION_KEEP_LIMIT = 10 +VERSION_FILE_PREFIX = "docker-compose" + +# Service whose environment section will be edited +SERVICE_NAME = "mumble" + + +def run_sudo_command(ssh, command): + full_command = f"echo '{PASSWORD}' | sudo -S {command}" + stdin, stdout, stderr = ssh.exec_command(full_command) + exit_code = stdout.channel.recv_exit_status() + + if exit_code != 0: + raise RuntimeError(stderr.read().decode("utf-8")) + + return stdout.read().decode("utf-8") if stdout.readable() else "" + + +def read_remote_file(ssh, path): + return run_sudo_command(ssh, f'cat "{path}"') + + +def write_remote_file(ssh, path, content): + # Encode content to base64 to avoid all shell quoting/escaping issues + encoded = base64.b64encode(content.encode("utf-8")).decode("ascii") + run_sudo_command(ssh, f"bash -c 'echo {encoded} | base64 -d > \"{path}\"'") + + +def ensure_version_dir(ssh): + run_sudo_command(ssh, f"mkdir -p {shlex.quote(VERSION_DIR)}") + + +def write_config_version(ssh, timestamp, content): + ensure_version_dir(ssh) + version_path = f"{VERSION_DIR}/{VERSION_FILE_PREFIX}_{timestamp}.yml" + write_remote_file(ssh, version_path, content) + prune_config_versions(ssh) + return version_path + + +def prune_config_versions(ssh): + keep_from = VERSION_KEEP_LIMIT + 1 + cleanup_script = ( + f"cd {shlex.quote(VERSION_DIR)} 2>/dev/null || exit 0\n" + f"ls -1t {VERSION_FILE_PREFIX}_*.yml 2>/dev/null " + f"| tail -n +{keep_from} " + "| xargs -r rm --" + ) + run_sudo_command(ssh, f"bash -c {shlex.quote(cleanup_script)}") + + +def backup_remote_file(ssh): + run_sudo_command(ssh, f'cp "{REMOTE_YAML}" "{BACKUP_YAML}"') + + +def parse_environment(env_list): + """ + Converts: + ["KEY1=value1", "KEY2=value2"] + To: + [("KEY1", "value1"), ("KEY2", "value2")] + """ + result = [] + for item in env_list: + if isinstance(item, str) and "=" in item: + key, value = item.split("=", 1) + result.append((key, value)) + return result + + +def format_environment(pairs): + """ + Converts: + [("KEY1", "value1"), ("KEY2", "value2")] + To: + ["KEY1=value1", "KEY2=value2"] + """ + return [f"{key}={value}" for key, value in pairs] + + +def load_environment_from_server(host, password): + print(f"Connecting to {host}...") + + ssh = paramiko.SSHClient() + ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy()) + + try: + ssh.connect(hostname=host, username=USERNAME, password=password, timeout=10) + + content = read_remote_file(ssh, REMOTE_YAML) + data = yaml.safe_load(content) + + env_list = data["services"][SERVICE_NAME].get("environment", []) + env_pairs = parse_environment(env_list) + + return ssh, data, env_pairs, content + + except Exception: + ssh.close() + raise + + +def save_environment_to_server(ssh, data, env_pairs): + data["services"][SERVICE_NAME]["environment"] = format_environment(env_pairs) + + # Create backup first + backup_remote_file(ssh) + + # Serialize YAML + output = io.StringIO() + yaml.dump(data, output, default_flow_style=False, sort_keys=False) + + # Write updated file + write_remote_file(ssh, REMOTE_YAML, output.getvalue()) + + +def save_versions_after_success(previous_configs, timestamp): + version_results = {} + + for host, content in previous_configs.items(): + try: + ssh = paramiko.SSHClient() + ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy()) + ssh.connect(hostname=host, username=USERNAME, password=PASSWORD, timeout=10) + try: + version_results[host] = write_config_version(ssh, timestamp, content) + finally: + ssh.close() + except Exception as e: + version_results[host] = str(e) + + return version_results + + +def edit_environment(env_pairs, json_data): + print(env_pairs,"ewejnwejnwejwej") + updated = [] + for key, value in env_pairs: + new_value = json_data.get(key, "") + if new_value == "": + updated.append((key, value)) # keep original + else: + updated.append((key, new_value)) + return updated + + +def run(json_data, servers=None): + target_servers = list(servers or SERVERS) + if not target_servers: + return { + "status": "error", + "message": "Select at least one VM to update.", + "results": {}, + } + + first_host = target_servers[0] + + try: + ssh, data, env_pairs, _ = load_environment_from_server(first_host, PASSWORD) + ssh.close() + except Exception as e: + return {"status": "error", "message": f"Failed to connect to {first_host}: {str(e)}"} + + updated_env = edit_environment(env_pairs, json_data) + + results = {} + previous_configs = {} + for host in target_servers: + try: + ssh, server_data, _, previous_content = load_environment_from_server(host, PASSWORD) + try: + save_environment_to_server(ssh, server_data, updated_env) + results[host] = "success" + previous_configs[host] = previous_content + finally: + ssh.close() + except Exception as e: + results[host] = str(e) + + if any(result != "success" for result in results.values()): + return { + "status": "error", + "message": "Config was not saved successfully to all selected VMs. No version files were created.", + "results": results, + } + + timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S") + version_results = save_versions_after_success(previous_configs, timestamp) + + if any( + not str(result).startswith(f"{VERSION_DIR}/") + for result in version_results.values() + ): + return { + "status": "error", + "message": "Config was saved to all selected VMs, but one or more version files could not be created.", + "results": results, + "version_results": version_results, + } + + return { + "status": "success", + "results": results, + "version_results": version_results, + } diff --git a/rec.py b/rec.py index e0d7e53..5a59de2 100644 --- a/rec.py +++ b/rec.py @@ -1,11 +1,11 @@ import alsaaudio import socket - +import opuslib # Network UDP_PORT = 5005 sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) sock.bind(("0.0.0.0", UDP_PORT)) - +decoder = opuslib.Decoder(48000, 1) # Audio RATE = 48000 CHANNELS = 1 @@ -30,7 +30,8 @@ try: while True: try: data, addr = sock.recvfrom(4096) - out.write(data) # play the 960 samples + pcm_data = decoder.decode(data, 960) + out.write(pcm_data) # play the 960 samples except socket.timeout: out.write(SILENCE) # packet lost → play silence diff --git a/sniffer.py b/sniffer.py index f77b720..419da71 100644 --- a/sniffer.py +++ b/sniffer.py @@ -4,9 +4,15 @@ import struct import Mumble_pb2 import threading import time +import opuslib +import alsaaudio +from cryptography.hazmat.primitives.ciphers.aead import AESOCB3 SERVER_IP = "172.16.11.170" SERVER_PORT = 64738 + +# KEY = None +# SERVER_NONCE = None # create raw TCP socket sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) @@ -85,6 +91,90 @@ ping_thread.daemon = True # dies when main program exits ping_thread.start() +decoder = opuslib.Decoder(48000, 1) + +CHUNKSIZE = 960 +out = alsaaudio.PCM( + alsaaudio.PCM_PLAYBACK, + alsaaudio.PCM_NORMAL, + channels=1, + rate=48000, + format=alsaaudio.PCM_FORMAT_S16_LE, + periodsize=CHUNKSIZE, + device='default' +) +SILENCE = b'\x00' * (CHUNKSIZE * 2) + + +def decrypt_udp(data): + if KEY is None or SERVER_NONCE is None: + print("No keys yet!") + return None + if len(data) < 4: + return None + nonce = bytes(SERVER_NONCE[0:15]) + bytes([data[0]]) + encrypted = data[4:] + try: + plaintext = AESOCB3(KEY).decrypt(nonce, encrypted, None) + return plaintext + except: + return None + +def parse_opus(plaintext): + if not plaintext: + return None + header = plaintext[0] + pkt_type = (header >> 5) & 0x7 + if pkt_type != 4: + return None + + offset = 1 + # skip sequence varint + while plaintext[offset] & 0x80: + offset += 1 + offset += 1 + + # parse opus length varint + opus_len = 0 + shift = 0 + while True: + byte = plaintext[offset] + opus_len |= (byte & 0x7F) << shift + offset += 1 + shift += 7 + if not (byte & 0x80): + break + + return plaintext[offset:offset + opus_len] + +# UDP listener thread +def udp_listener(): + udp_sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) + udp_sock.bind(("172.16.11.170", 64738)) # bind to any available port + udp_sock.settimeout(0.05) + + print("UDP listener started...") + while True: + try: + data, addr = udp_sock.recvfrom(1024) + if addr[0] != SERVER_IP: + continue + + plaintext = decrypt_udp(data) + opus_data = parse_opus(plaintext) + + if opus_data: + pcm = decoder.decode(opus_data, CHUNKSIZE) + out.write(pcm) + print(f"Playing audio | Opus: {len(opus_data)}B → PCM: {len(pcm)}B") + except socket.timeout: + print(KEY,SERVER_NONCE,"SWS") + out.write(SILENCE) + +udp_thread = threading.Thread(target=udp_listener) +udp_thread.daemon = True +udp_thread.start() + while True: msg_type, data = recv_message(tls) if msg_type is None: @@ -112,8 +202,13 @@ while True: print(" FULLY CONNECTED TO MUMBLE! ✅") elif msg_type == 15: # CryptSetup — encryption keys! + global KEY, SERVER_NONCE + KEY = None + SERVER_NONCE = None c = Mumble_pb2.CryptSetup() c.ParseFromString(data) + KEY = bytes(c.key) + SERVER_NONCE = bytearray(c.server_nonce) print(f" KEY: {c.key.hex()}") print(f" CLIENT_NONCE: {c.client_nonce.hex()}") print(f" SERVER_NONCE: {c.server_nonce.hex()}") \ No newline at end of file diff --git a/test.py b/test.py new file mode 100644 index 0000000..95b6cce --- /dev/null +++ b/test.py @@ -0,0 +1,94 @@ +import sys +import Ice +import MumbleServer +import re + +HOST = "172.16.10.3" # VM IP +INTERNAL = "172.19.0.2" # container IP + +def fix_proxy(prx, communicator): + s = communicator.proxyToString(prx) + # Match any IP address pattern after "-h " and replace it + s = re.sub(r'-h (\d{1,3}\.){3}\d{1,3}', f'-h {HOST}', s) + return communicator.stringToProxy(s) + +def main(): + with Ice.initialize(sys.argv) as communicator: + base = communicator.stringToProxy(f"Meta:tcp -h {HOST} -p 6502 -t 60000") + meta = MumbleServer.MetaPrx.checkedCast(base) + + assert meta is not None + + context = {"secret": "password"} + + # We just assume the server we want to modify has ID 1 + server = meta.getServer(1, context) + print("Server:", server) + + server = MumbleServer.ServerPrx.uncheckedCast(fix_proxy(server, communicator)) + print("Running:", server) + assert server is not None + users = server.getUsers(context) + + # Python 3 uses .items(), not .iteritems() + for session_id, user in users.items(): + print(session_id, user.name) + + # Not providing the context with the correct password would make this + # request fail with an InvalidSecretException + server.setSuperuserPassword("Strong password", context) + + +if __name__ == "__main__": + main() + + + +# import Ice +# import MumbleServer + +# HOST = "172.16.10.123" # external VM IP +# PORT = 6502 +# ICE_SECRET = "password" +# SERVER_ID = 1 +# INTERNAL = "172.19.0.2" # container IP to replace + +# props = Ice.createProperties() +# props.setProperty("Ice.ImplicitContext", "Shared") + +# init = Ice.InitializationData() +# init.properties = props + +# def fix_proxy(prx, communicator): +# """Replace internal container IP with external VM IP in proxy string.""" +# s = communicator.proxyToString(prx) +# s = s.replace(INTERNAL, HOST) +# return communicator.stringToProxy(s) + +# with Ice.initialize(initData=init) as communicator: +# communicator.getImplicitContext().put("secret", ICE_SECRET) + +# proxy = communicator.stringToProxy(f"Meta:tcp -h {HOST} -p {PORT} -t 10000") +# meta = MumbleServer.MetaPrx.uncheckedCast(proxy) + +# try: +# version = meta.getVersion() +# print("Connected! Version:", version) + +# # Fix the server proxy endpoint before using it +# raw_server = meta.getServer(SERVER_ID) +# fixed = fix_proxy(raw_server, communicator) +# server = MumbleServer.ServerPrx.uncheckedCast(fixed) + +# print("Running:", server.isRunning()) + +# for cid, ch in server.getChannels().items(): +# print(f" [{cid}] {ch.name}") + +# users = server.getUsers() +# print("Online users:", len(users)) +# for sid, u in users.items(): +# print(f" [{sid}] {u.name}") + +# except Exception as e: +# print("Error:", type(e).__name__, e) \ No newline at end of file