C# Class OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule

Callback for a client request for a private chat channel

OnRegisterCaps is invoked via the scene.EventManager everytime OpenSim hands out capabilities to a client (login, region crossing). We contribute two capabilities to the set of capabilities handed back to the client: ProvisionVoiceAccountRequest and ParcelVoiceInfoRequest. ProvisionVoiceAccountRequest allows the client to obtain the voice account credentials for the avatar it is controlling (e.g., user name, password, etc). ParcelVoiceInfoRequest is invoked whenever the client changes from one region or parcel to another. Note that OnRegisterCaps is called here via a closure delegate containing the scene of the respective region (see Initialise()).

Callback for a client request for ParcelVoiceInfo

Callback for a client request for Voice Account Details

Login has been factored in this way because it gets called from several places in the module, and we want it to work the same way each time.

Just say if it worked.

This method handles the WEB side of making a request over the Vivox interface. The returned values are tansferred to a has table which is returned as the result. The outcome of the call can be determined by examining the status value in the hash table.

Creates a new account. For now we supply the minimum set of values, which is user name and password. We *can* supply a lot more demographic data.

Retrieve account information for the specified user. Returns a hash table containing values returned from the request.

Perform administrative login for Vivox. Returns a hash table containing values returned from the request.

Perform administrative logout for Vivox.

Change the user's password.

Create a channel. Once again, there a multitude of options possible. In the simplest case we specify only the name and get a non-persistent cannel in return. Non persistent means that the channel gets deleted if no-one uses it for 5 hours. To accomodate future requirements, it may be a good idea to initially create channels under the umbrella of a parent ID based upon the region name. That way we have a context for side channels, if those are required in a later phase. In this case the call handles parent and description as optional values.

Create a directory. Create a channel with an unconditional type of "dir" (indicating directory). This is used to create an arbitrary name tree for partitioning of the channel name space. The parent and description are optional values.

Retrieve a channel. Once again, there a multitude of options possible. In the simplest case we specify only the name and get a non-persistent cannel in return. Non persistent means that the channel gets deleted if no-one uses it for 5 hours. To accomodate future requirements, it may be a good idea to initially create channels under the umbrella of a parent ID based upon the region name. That way we have a context for side channels, if those are required in a later phase. In this case the call handles parent and description as optional values.

The Find method is passed an element whose inner text is scanned in an attempt to match the name hierarchy passed in the 'tag' parameter. If the whole hierarchy is resolved, the InnerText value at that point is returned. Note that this may itself be a subhierarchy of the entire document. The function returns a boolean indicator of the search's success. The search is performed by the recursive Search method.

The XmlScan routine is provided to aid in the reverse engineering of incompletely documented packets returned by the Vivox voice server. It is only called if the m_dumpXml switch is set.

XmlSearch is initially called by XmlFind, and then recursively called by itself until the document supplied to XmlFind is either exhausted or the name hierarchy is matched. If the hierarchy is matched, the value is returned in result, and true returned as the function's value. Otherwise the result is set to the empty string and false is returned.