Services

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Services)
Line 7: Line 7:
 
Every service is stateless - in other words, individual requests have no relationship to each other so can be load-balanced to multiple copies of a particular service (e.g. inventory).
 
Every service is stateless - in other words, individual requests have no relationship to each other so can be load-balanced to multiple copies of a particular service (e.g. inventory).
  
Most services are grid services (i.e. every simulator connects to them in a hub-spoke pattern).  However, some services are implemented by each simulator where one simulator needs to request data from another (e.g. land data).
+
Most services are grid services (i.e. every simulator connects to them in a hub-spoke pattern).  However, some services (simulator services) are implemented by each simulator where one simulator needs to request data from another (e.g. land data).
  
 
==Grid Services==
 
==Grid Services==
Line 47: Line 47:
 
|-
 
|-
 
| UserAccount    || UserAccounts          || User account storage.
 
| UserAccount    || UserAccounts          || User account storage.
 +
|}
 +
 +
==Simulator Services==
 +
 +
Here is a table of each simulator service in OpenSimulator and its function.  All service interfaces are in the package OpenSim.Services.Interfaces.
 +
 +
{| border="1"
 +
! Service        !! Description
 +
|-
 +
| Land          || Provides land data for a particular simulator.  Read only.
 +
|-
 +
| Simulation    || General simulation functions (create agent, update agent, create object, etc.).  User in both login service -> simulator comms (e.g. login service creating an agent at a target region) and simulator -> simulator comms (e.g. teleport, updating child agents, moving objects between regions, etc.).
 
|}
 
|}

Revision as of 17:07, 18 April 2012

Introduction

OpenSimulator can be conceptually divided into the simulator itself (the part that handles objects and avatars in the scene, physics, terrain, etc.) and a set of services (assets, inventory, etc.) that handle grid-wide data storage and retrieval. Data specific to an individual simulator (e.g. object positions, prim inventory contents) is stored at the simulator itself.

In standalone configuration both simulator and services run in the same process (OpenSim.exe). In grid mode, each simulator runs in a separate process (OpenSim.exe) and they connect to one or more ROBUST shells (Robust.exe) or an alternative service implementation that host the services. See Configuration#Standalone_vs._Grid for a diagrammatic view.

Every service is stateless - in other words, individual requests have no relationship to each other so can be load-balanced to multiple copies of a particular service (e.g. inventory).

Most services are grid services (i.e. every simulator connects to them in a hub-spoke pattern). However, some services (simulator services) are implemented by each simulator where one simulator needs to request data from another (e.g. land data).

Grid Services

Here is a table of each grid service in OpenSimulator and its function. All service interfaces are in the package OpenSim.Services.Interfaces.

Service ROBUST database tables Description
Asset assets Stores asset data (textures, serialized objects, scripts, etc.) and provides this on request
Authentication auth, tokens Handles login authentication. Core implementations are password and webkey.
Authorization none Checks if the user is authorized to enter a given region
Avatar Avatars Holds avatar appearance, height and attachment data.
BasicProfile n/a Stub basic profile service. Currently unused (?).
Freeswitch n/a Freeswitch voice service. Very low quality voice as the viewer falls back to a debug codec - not freeswitch's fault.
Friends Friends User friends data storage
Grid regions Holds region information for a grid. Simulators register here on startup.
GridUser GridUser Records status information for a user on a grid, including home position and whether they are online or not. On a non-Hypergrid setup, each grid user will have a user account.
HG* n/a Hypergrid services. These usually override 'normal' services (e.g. asset, inventory) with some Hypergrid specific functionality
Inventory inventoryitems, inventoryfolders User inventory storage
Library stored on filesystem Library items and folders.
Login n/a Handles user login. OpenSimulator implements an LL login service.
MapImage stored on filesystem Stores and provides main map image tiles.
Presence Presence Records user sessions and the region location of a particular session. Used for instant message routing, amongst other things.
UserAccount UserAccounts User account storage.

Simulator Services

Here is a table of each simulator service in OpenSimulator and its function. All service interfaces are in the package OpenSim.Services.Interfaces.

Service Description
Land Provides land data for a particular simulator. Read only.
Simulation General simulation functions (create agent, update agent, create object, etc.). User in both login service -> simulator comms (e.g. login service creating an agent at a target region) and simulator -> simulator comms (e.g. teleport, updating child agents, moving objects between regions, etc.).
Personal tools
General
About This Wiki