OpenSim::Data::MySQL::MySQLGridData

OpenSim::Data::MySQL::MySQLGridData Class Reference

A MySQL Interface for the Grid Server. More...

Inheritance diagram for OpenSim::Data::MySQL::MySQLGridData:

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

Public Member Functions

MySQLSuperManager GetLockedConnection ()
override void Initialise ()
 Default-initialises the plugin.
override void Initialise (string connect)
 Initialises Grid interface

  • Loads and initialises the MySQL storage plugin
  • Warns and uses the obsolete mysql_connection.ini if connect string is empty.
  • Check for migration

override void Dispose ()
 Shuts down the grid interface.
override RegionProfileData[] GetProfilesInRange (uint xmin, uint ymin, uint xmax, uint ymax)
 Returns all the specified region profiles within coordates -- coordinates are inclusive.
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 location.
override RegionProfileData GetProfileByUUID (UUID uuid)
 Returns a sim profile from it's UUID.
override RegionProfileData GetProfileByString (string regionName)
 Returns a sim profile from it's Region name string.
override DataResponse AddProfile (RegionProfileData profile)
 Adds a new profile to the database.
override DataResponse UpdateProfile (RegionProfileData profile)
 Update a sim profile.
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)
 Adds a location reservation.

Public Attributes

Dictionary< int, MySQLSuperManager > m_dbconnections = new Dictionary<int, MySQLSuperManager>()
 Better DB manager. Swap-in replacement too.
int m_maxConnections = 10
int m_lastConnect

Properties

override string Name [get]
 Returns the plugin name.
override string Version [get]
 Returns the plugin version.

Detailed Description

A MySQL Interface for the Grid Server.

Member Function Documentation

MySQLSuperManager OpenSim::Data::MySQL::MySQLGridData::GetLockedConnection (  )  [inline]

override void OpenSim::Data::MySQL::MySQLGridData::Initialise (  )  [inline, virtual]

Default-initialises the plugin.

Implements OpenSim::Data::GridDataBase.

override void OpenSim::Data::MySQL::MySQLGridData::Initialise ( string  connect  )  [inline, virtual]

Initialises Grid interface

Parameters:
connect connect string.

Implements OpenSim::Data::GridDataBase.

override void OpenSim::Data::MySQL::MySQLGridData::Dispose (  )  [inline, virtual]

Shuts down the grid interface.

Implements OpenSim::Data::GridDataBase.

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

Returns all the specified region profiles within coordates -- coordinates are inclusive.

Parameters:
xmin Minimum X coordinate
ymin Minimum Y coordinate
xmax Maximum X coordinate
ymax Maximum Y coordinate
Returns:
Array of sim profiles

Implements OpenSim::Data::GridDataBase.

override List<RegionProfileData> OpenSim::Data::MySQL::MySQLGridData::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::MySQL::MySQLGridData::GetProfileByHandle ( ulong  handle  )  [inline, virtual]

Returns a sim profile from it's location.

Parameters:
handle Region location handle
Returns:
Sim profile

Implements OpenSim::Data::GridDataBase.

override RegionProfileData OpenSim::Data::MySQL::MySQLGridData::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.

override RegionProfileData OpenSim::Data::MySQL::MySQLGridData::GetProfileByString ( string  regionName  )  [inline, virtual]

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

Returns:
The sim profile

Implements OpenSim::Data::GridDataBase.

override DataResponse OpenSim::Data::MySQL::MySQLGridData::AddProfile ( RegionProfileData  profile  )  [inline, virtual]

Adds a new profile to the database.

Parameters:
profile The profile to add
Returns:
Successful?

Implements OpenSim::Data::GridDataBase.

override DataResponse OpenSim::Data::MySQL::MySQLGridData::UpdateProfile ( RegionProfileData  profile  )  [inline, virtual]

Update a sim profile.

Parameters:
profile The profile to update
Returns:
Sucessful?
Same as AddProfile

Implements OpenSim::Data::GridDataBase.

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

Adds a location reservation.

Parameters:
x x coordinate
y y coordinate
Returns:

Implements OpenSim::Data::GridDataBase.

Member Data Documentation

Dictionary<int, MySQLSuperManager> OpenSim::Data::MySQL::MySQLGridData::m_dbconnections = new Dictionary<int, MySQLSuperManager>()

Better DB manager. Swap-in replacement too.

int OpenSim::Data::MySQL::MySQLGridData::m_maxConnections = 10

int OpenSim::Data::MySQL::MySQLGridData::m_lastConnect

Property Documentation

override string OpenSim::Data::MySQL::MySQLGridData::Name [get]

Returns the plugin name.

Returns:
Plugin name

Reimplemented from OpenSim::Data::GridDataBase.

override string OpenSim::Data::MySQL::MySQLGridData::Version [get]

Returns the plugin version.

Returns:
Plugin version

Reimplemented from OpenSim::Data::GridDataBase.

The documentation for this class was generated from the following file:
Generated on Mon Jan 5 01:00:38 2009 for OpenSim by  doxygen 1.5.1