/*
* Copyright (c) 2007, Second Life Reverse Engineering Team
* All rights reserved.
*
* - Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* - Neither the name of the Second Life Reverse Engineering Team nor the names
* of its contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading;
using libsecondlife.LLSD;
namespace libsecondlife
{
///
/// Capabilities is the name of the bi-directional HTTP REST protocol that
/// Second Life uses to communicate transactions such as teleporting or
/// group messaging
///
public class Capabilities
{
///
/// Triggered when an event is received via the EventQueueGet
/// capability
///
/// Event name
/// Decoded event data
/// The CAPS system that made the call
public delegate void EventQueueCallback(string message, Dictionary body, CapsEventQueue eventQueue);
///
/// Triggered when an HTTP call in the queue is executed and a response
/// is received
///
/// Decoded response
/// Original capability request
public delegate void CapsResponseCallback(Dictionary body, HttpRequestState request);
/// Reference to the simulator this system is connected to
public Simulator Simulator;
internal string _SeedCapsURI;
internal Dictionary _Caps = new Dictionary();
private CapsRequest _SeedRequest;
private CapsEventQueue _EventQueueCap = null;
/// Capabilities URI this system was initialized with
public string SeedCapsURI { get { return _SeedCapsURI; } }
public ManualResetEvent CapsReceivedEvent = new ManualResetEvent(false);
/// Whether the capabilities event queue is connected and
/// listening for incoming events
public bool IsEventQueueRunning
{
get
{
if (_EventQueueCap != null)
return _EventQueueCap.Running;
else
return false;
}
}
///
/// Default constructor
///
///
///
///
internal Capabilities(Simulator simulator, string seedcaps)
{
Simulator = simulator;
_SeedCapsURI = seedcaps;
MakeSeedRequest();
}
public void Disconnect(bool immediate)
{
Simulator.Client.Log(String.Format("Caps system for {0} is {1}", Simulator,
(immediate ? "aborting" : "disconnecting")), Helpers.LogLevel.Info);
if (_SeedRequest != null)
{
_SeedRequest.Abort();
}
if (_EventQueueCap != null)
{
_EventQueueCap.Disconnect(immediate);
}
}
///
/// Request the URI of a named capability
///
/// Name of the capability to request
/// The URI of the requested capability, or String.Empty if
/// the capability does not exist
public string CapabilityURI(string capability)
{
string cap;
if (_Caps.TryGetValue(capability, out cap))
return cap;
else
return String.Empty;
}
private void MakeSeedRequest()
{
if (Simulator == null || !Simulator.Client.Network.Connected)
return;
// Create a request list
List