OpenSim::Data::MSSQL::MSSQLGridData

OpenSim::Data::MSSQL::MSSQLGridData Class Reference

A grid data interface for MSSQL Server. More...

Inheritance diagram for OpenSim::Data::MSSQL::MSSQLGridData:

OpenSim::Data::GridDataBase OpenSim::Data::IGridDataPlugin OpenSim::Framework::IPlugin List of all members.

Public Member Functions

override void Initialise ()
 Default-initialises the plugin.
override void Initialise (string connectionString)
 Initialises the Grid Interface.
override void Dispose ()
 Shuts down the grid interface.
override RegionProfileData[] GetProfilesInRange (uint xmin, uint ymin, uint xmax, uint ymax)
 Returns a list of regions within the specified ranges.
override List< RegionProfileData > GetRegionsByName (string namePrefix, uint maxNum)
 Returns up to maxNum profiles of regions that have a name starting with namePrefix.
override RegionProfileData GetProfileByHandle (ulong handle)
 Returns a sim profile from its location.
override RegionProfileData GetProfileByUUID (UUID uuid)
 Returns a sim profile from its UUID.
override RegionProfileData GetProfileByString (string regionName)
 Returns a sim profile from it's Region name string.
override DataResponse AddProfile (RegionProfileData profile)
 Adds a new specified region to the database.
override DataResponse UpdateProfile (RegionProfileData profile)
 Update the specified region in the database.
override DataResponse DeleteProfile (string uuid)
 Deletes a sim profile from the database.
override bool AuthenticateSim (UUID uuid, ulong handle, string authkey)
 DEPRECATED. Attempts to authenticate a region by comparing a shared secret.
bool AuthenticateSim (UUID uuid, ulong handle, string authhash, string challenge)
 NOT YET FUNCTIONAL. Provides a cryptographic authentication of a region.
override ReservationData GetReservationAtPoint (uint x, uint y)
 NOT IMPLEMENTED WHEN IS THIS GONNA BE IMPLEMENTED.

Properties

override string Name [get]
 The name of this DB provider.
override string Version [get]
 Database provider version.

Detailed Description

A grid data interface for MSSQL Server.

Member Function Documentation

override void OpenSim::Data::MSSQL::MSSQLGridData::Initialise (  )  [inline, virtual]

Default-initialises the plugin.

Implements OpenSim::Data::GridDataBase.

override void OpenSim::Data::MSSQL::MSSQLGridData::Initialise ( string  connectionString  )  [inline, virtual]

Initialises the Grid Interface.

Parameters:
connectionString connect string
use mssql_connection.ini

Implements OpenSim::Data::GridDataBase.

override void OpenSim::Data::MSSQL::MSSQLGridData::Dispose (  )  [inline, virtual]

Shuts down the grid interface.

Implements OpenSim::Data::GridDataBase.

override RegionProfileData [] OpenSim::Data::MSSQL::MSSQLGridData::GetProfilesInRange ( uint  xmin,
uint  ymin,
uint  xmax,
uint  ymax 
) [inline, virtual]

Returns a list of regions within the specified ranges.

Parameters:
xmin minimum X coordinate
ymin minimum Y coordinate
xmax maximum X coordinate
ymax maximum Y coordinate
Returns:
null
always return null

Implements OpenSim::Data::GridDataBase.

override List<RegionProfileData> OpenSim::Data::MSSQL::MSSQLGridData::GetRegionsByName ( string  namePrefix,
uint  maxNum 
) [inline, virtual]

Returns up to maxNum profiles of regions that have a name starting with namePrefix.

Parameters:
namePrefix The name to match against
maxNum Maximum number of profiles to return
Returns:
A list of sim profiles

Implements OpenSim::Data::GridDataBase.

override RegionProfileData OpenSim::Data::MSSQL::MSSQLGridData::GetProfileByHandle ( ulong  handle  )  [inline, virtual]

Returns a sim profile from its location.

Parameters:
handle Region location handle
Returns:
Sim profile

Implements OpenSim::Data::GridDataBase.

override RegionProfileData OpenSim::Data::MSSQL::MSSQLGridData::GetProfileByUUID ( UUID  uuid  )  [inline, virtual]

Returns a sim profile from its UUID.

Parameters:
uuid The region UUID
Returns:
The sim profile

Implements OpenSim::Data::GridDataBase.

override RegionProfileData OpenSim::Data::MSSQL::MSSQLGridData::GetProfileByString ( string  regionName  )  [inline, virtual]

Returns a sim profile from it's Region name string.

Parameters:
regionName The region name search query
Returns:
The sim profile

Implements OpenSim::Data::GridDataBase.

override DataResponse OpenSim::Data::MSSQL::MSSQLGridData::AddProfile ( RegionProfileData  profile  )  [inline, virtual]

Adds a new specified region to the database.

Parameters:
profile The profile to add
Returns:
A dataresponse enum indicating success

Implements OpenSim::Data::GridDataBase.

override DataResponse OpenSim::Data::MSSQL::MSSQLGridData::UpdateProfile ( RegionProfileData  profile  )  [inline, virtual]

Update the specified region in the database.

Parameters:
profile The profile to update
Returns:
A dataresponse enum indicating success

Implements OpenSim::Data::GridDataBase.

override DataResponse OpenSim::Data::MSSQL::MSSQLGridData::DeleteProfile ( string  uuid  )  [inline, virtual]

Deletes a sim profile from the database.

Parameters:
uuid the sim UUID
Returns:
Successful?

Implements OpenSim::Data::GridDataBase.

override bool OpenSim::Data::MSSQL::MSSQLGridData::AuthenticateSim ( UUID  uuid,
ulong  handle,
string  authkey 
) [inline, virtual]

DEPRECATED. Attempts to authenticate a region by comparing a shared secret.

Parameters:
uuid The UUID of the challenger
handle The attempted regionHandle of the challenger
authkey The secret
Returns:
Whether the secret and regionhandle match the database entry for UUID

Implements OpenSim::Data::GridDataBase.

bool OpenSim::Data::MSSQL::MSSQLGridData::AuthenticateSim ( UUID  uuid,
ulong  handle,
string  authhash,
string  challenge 
) [inline]

NOT YET FUNCTIONAL. Provides a cryptographic authentication of a region.

This requires a security audit.

Parameters:
uuid 
handle 
authhash 
challenge 
Returns:

override ReservationData OpenSim::Data::MSSQL::MSSQLGridData::GetReservationAtPoint ( uint  x,
uint  y 
) [inline, virtual]

NOT IMPLEMENTED WHEN IS THIS GONNA BE IMPLEMENTED.

Parameters:
x 
y 
Returns:
null

Implements OpenSim::Data::GridDataBase.

Property Documentation

override string OpenSim::Data::MSSQL::MSSQLGridData::Name [get]

The name of this DB provider.

Returns:
A string containing the storage system name

Reimplemented from OpenSim::Data::GridDataBase.

override string OpenSim::Data::MSSQL::MSSQLGridData::Version [get]

Database provider version.

Returns:
A string containing the storage system version

Reimplemented from OpenSim::Data::GridDataBase.

The documentation for this class was generated from the following file:
Generated on Tue Jan 6 01:00:46 2009 for OpenSim by  doxygen 1.5.1