OpenSimMirror/Common/OpenSim.Framework/Interfaces/IGridServer.cs

/*
* Copyright (c) Contributors, http://www.openmetaverse.org/
* See CONTRIBUTORS.TXT for a full list of copyright holders.
*
* 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.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of the OpenSim Project 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 DEVELOPERS ``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 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;
using System.Collections.Generic;
using System.Net;
using System.Net.Sockets;
using System.IO;
using libsecondlife;
using OpenSim;
using OpenSim.Framework.Types;

namespace OpenSim.Framework.Interfaces
{
    /// <summary>
    /// Handles connection to Grid Servers.
    /// also Sim to Sim connections?
    /// </summary>

    public interface IGridServer
    {
        UUIDBlock RequestUUIDBlock();
        NeighbourInfo[] RequestNeighbours(); //should return a array of neighbouring regions
        AuthenticateResponse AuthenticateSession(LLUUID sessionID, LLUUID agentID, uint circuitCode);
        bool LogoutSession(LLUUID sessionID, LLUUID agentID, uint circuitCode);
        string GetName();
        bool RequestConnection(LLUUID SimUUID, string sim_ip, uint sim_port);
        void SetServerInfo(string ServerUrl, string SendKey, string RecvKey);
        IList RequestMapBlocks(int minX, int minY, int maxX, int maxY);
        void Close();
    }
    
    public struct UUIDBlock
    {
        public LLUUID BlockStart;
        public LLUUID BlockEnd;
    }

    public class AuthenticateResponse
    {
        public bool Authorised;
        public Login LoginInfo;

        public AuthenticateResponse()
        {

        }

    }

    public interface IGridPlugin
    {
        IGridServer GetGridServer();
    }
}