OpenSim::Data::SQLite::SQLiteGridData Class Reference

A Grid Interface to the SQLite database. More...

Inheritance diagram for OpenSim::Data::SQLite::SQLiteGridData:

List of all members.

Public Member Functions
override void	Initialise ()
	Default-initialises the plugin.
override void	Initialise (string connect)
	Initialises Inventory interface Loads and initialises a new SQLite connection and maintains it. use default URI if connect string is empty.
override void	Dispose ()
	Shuts down the grid interface.
override RegionProfileData[]	GetProfilesInRange (uint a, uint b, uint c, uint d)
	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 it's handle.
override RegionProfileData	GetProfileByString (string regionName)
	Returns a sim profile from it's Region name string.
override RegionProfileData	GetProfileByUUID (UUID uuid)
	Returns a sim profile from it's UUID.
List< AvatarPickerAvatar >	GeneratePickerResults (UUID queryID, string query)
	Returns a list of avatar and UUIDs that match the query.
override DataResponse	AddProfile (RegionProfileData profile)
	Adds a new specified region to the database.
override DataResponse	UpdateProfile (RegionProfileData profile)
	Updates a profile in the database.
override DataResponse	DeleteProfile (string uuid)
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.
Properties
override string	Name [get]
	Returns the name of this grid interface.
override string	Version [get]
	Returns the version of this grid interface.

---

Detailed Description

A Grid Interface to the SQLite database.

---

Member Function Documentation

override void OpenSim::Data::SQLite::SQLiteGridData::Initialise

(

)

[inline, virtual]

Default-initialises the plugin.

Implements OpenSim::Data::GridDataBase.

override void OpenSim::Data::SQLite::SQLiteGridData::Initialise

(

string

connect

)

[inline, virtual]

• Initialises Inventory interface
• Loads and initialises a new SQLite connection and maintains it.
• use default URI if connect string is empty.

Parameters:

dbconnect

connect string

Implements OpenSim::Data::GridDataBase.

override void OpenSim::Data::SQLite::SQLiteGridData::Dispose

(

)

[inline, virtual]

Shuts down the grid interface.

Implements OpenSim::Data::GridDataBase.

override RegionProfileData [] OpenSim::Data::SQLite::SQLiteGridData::GetProfilesInRange	(	uint	a,
		uint	b,
		uint	c,
		uint	d
	)			[inline, virtual]

Returns a list of regions within the specified ranges.

Parameters:

	a	minimum X coordinate
	b	minimum Y coordinate
	c	maximum X coordinate
	d	maximum Y coordinate

Returns:

An array of region profiles

NOT IMPLEMENTED ? always return null

Implements OpenSim::Data::GridDataBase.

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

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

Parameters:

	name	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::SQLite::SQLiteGridData::GetProfileByHandle

(

ulong

handle

)

[inline, virtual]

Returns a sim profile from it's handle.

Parameters:

handle

Region location handle

Returns:

Sim profile

Implements OpenSim::Data::GridDataBase.

override RegionProfileData OpenSim::Data::SQLite::SQLiteGridData::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 RegionProfileData OpenSim::Data::SQLite::SQLiteGridData::GetProfileByUUID

(

UUID

uuid

)

[inline, virtual]

Returns a sim profile from it's UUID.

Parameters:

uuid

The region UUID

Returns:

The sim profile

Implements OpenSim::Data::GridDataBase.

List<AvatarPickerAvatar> OpenSim::Data::SQLite::SQLiteGridData::GeneratePickerResults	(	UUID	queryID,
		string	query
	)			[inline]

Returns a list of avatar and UUIDs that match the query.

do nothing yet

override DataResponse OpenSim::Data::SQLite::SQLiteGridData::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::SQLite::SQLiteGridData::UpdateProfile

(

RegionProfileData

profile

)

[inline, virtual]

Updates a profile in the database.

Parameters:

profile

Returns:

Implements OpenSim::Data::GridDataBase.

override DataResponse OpenSim::Data::SQLite::SQLiteGridData::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::SQLite::SQLiteGridData::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::SQLite::SQLiteGridData::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::SQLite::SQLiteGridData::GetReservationAtPoint	(	uint	x,
		uint	y
	)			[inline, virtual]

NOT IMPLEMENTED.

Parameters:

	x	x coordinate
	y	y coordinate

Returns:

always return null

Implements OpenSim::Data::GridDataBase.

---

Property Documentation

override string OpenSim::Data::SQLite::SQLiteGridData::Name [get]

Returns the name of this grid interface.

Returns:

A string containing the grid interface

Reimplemented from OpenSim::Data::GridDataBase.

override string OpenSim::Data::SQLite::SQLiteGridData::Version [get]

Returns the version of this grid interface.

Returns:

A string containing the version

Reimplemented from OpenSim::Data::GridDataBase.

---

The documentation for this class was generated from the following file:

• /home/sdague/opensim-docs/OpenSim/Data/SQLite/SQLiteGridData.cs

---