OpenSimulator Internals/Connector Architecture - Revision history

Jwbshaw at 07:14, 9 July 2026

2026-07-09T07:14:19Z

← Older revision		Revision as of 07:14, 9 July 2026
Line 47:		Line 47:
	\|-		\|-
	\| [[OpenSimulator Internals/Connector Architecture/Inventory Connector]] \|\| IInventoryService \|\| XInventory protocol. UpdateFolder() URL-encodes Name; AddFolder() does not.		\| [[OpenSimulator Internals/Connector Architecture/Inventory Connector]] \|\| IInventoryService \|\| XInventory protocol. UpdateFolder() URL-encodes Name; AddFolder() does not.
			\|-
			\| HGInventoryService \|\| IInventoryService \|\| HG-only. Pre-suitcase implementation. Returns "My Suitcase" folder as root by name lookup. Does not enforce suitcase tree boundaries on operations. Adjusts CreatorData on item fetch to include home grid URL. Deletions and skeleton requests blocked. Present in current code but not recommended for new deployments.
			\|-
			\| HGSuitcaseInventoryService \|\| IInventoryService \|\| HG-only. Current implementation. Enforces strict suitcase tree boundaries on all folder and item operations. Creates system subfolders under suitcase on first use. Allows access to appearance items outside the suitcase tree. Caches suitcase tree and appearance data (5-minute expiry). Requires AvatarService in config in addition to UserAccountsService. Deletions blocked.
	\|-		\|-
	\| [[OpenSimulator Internals/Connector Architecture/Authentication Connector]] \|\| IAuthenticationService \|\| Password and token authentication, impersonation mechanism.		\| [[OpenSimulator Internals/Connector Architecture/Authentication Connector]] \|\| IAuthenticationService \|\| Password and token authentication, impersonation mechanism.
Line 72:		Line 76:
	* Gatekeeper Connector -- used to contact a foreign grid's Gatekeeper during HG destination resolution.		* Gatekeeper Connector -- used to contact a foreign grid's Gatekeeper during HG destination resolution.
	* HGAsset Connector -- used by HGInventoryAccessModule to fetch/push assets between grids (via HGAssetMapper).		* HGAsset Connector -- used by HGInventoryAccessModule to fetch/push assets between grids (via HGAssetMapper).
			* HGInventoryService / HGSuitcaseInventoryService -- inventory access for visiting HG users. HGSuitcaseInventoryService is current; HGInventoryService is the pre-suitcase predecessor. Both block deletions.

	Note: prior to 0.9.2, the HGAssetBroker region module handled the local/remote/foreign asset routing decision. It was retired in 0.9.2 and replaced by RegionAssetConnector. References to HGAssetBroker in older documentation and config examples are obsolete.		Note: prior to 0.9.2, the HGAssetBroker region module handled the local/remote/foreign asset routing decision. It was retired in 0.9.2 and replaced by RegionAssetConnector. References to HGAssetBroker in older documentation and config examples are obsolete.

Jwbshaw: updated with content from opensimulator.org wiki

2026-07-07T23:25:37Z

updated with content from opensimulator.org wiki

Jwbshaw: update

2026-07-07T13:23:00Z

update

← Older revision		Revision as of 13:23, 7 July 2026
Line 1:		Line 1:


	= OpenSimulator Internals/Connector Architecture =		= OpenSimulator Internals/Connector Architecture =

Jwbshaw: more stuff

2026-07-07T12:31:57Z

more stuff

Show changes

Jwbshaw: Configuration examples updated to RegionAssetConnector, and Asset Connector added to See Also.

2026-06-22T09:47:33Z

Configuration examples updated to RegionAssetConnector, and Asset Connector added to See Also.

← Older revision		Revision as of 09:47, 22 June 2026
Line 1:		Line 1:

	= OpenSimulator Internals/Connector Architecture =		= OpenSimulator Internals/Connector Architecture =

Line 30:		Line 31:

	== Configuration ==		== Configuration ==

			Note: In OpenSimulator 0.9.2, LocalAssetServiceConnector, RemoteAssetServiceConnector, and HGAssetBroker were replaced by a single module RegionAssetConnector. The examples below reflect the current architecture.

	=== Standalone ===		=== Standalone ===
Line 36:		Line 39:

	[Modules]		[Modules]
	AssetServices = "~~LocalAssetServicesConnector~~"		AssetServices = "RegionAssetConnector"

	[AssetService]		[AssetService]
	~~LocalServiceModule~~ = "OpenSim.Services.AssetService.dll:AssetService"		LocalGridAssetService = "OpenSim.Services.AssetService.dll:AssetService"

	=== Grid ===		=== Grid ===

	Service runs remotely:		Service runs remotely on ROBUST:

	[Modules]		[Modules]
	AssetServices = "~~RemoteAssetServicesConnector~~"		AssetServices = "RegionAssetConnector"

	[AssetService]		[AssetService]
			LocalGridAssetService = "OpenSim.Services.AssetService.dll:AssetService"
	AssetServerURI = "http://myassetserver.com:8003"		AssetServerURI = "http://myassetserver.com:8003"

Line 54:		Line 58:

	== Example: Asset Get ==		== Example: Asset Get ==

	Note: In OpenSimulator 0.9.2, LocalAssetServiceConnector, RemoteAssetServiceConnector, and HGAssetBroker were replaced by a single module RegionAssetConnector. LocalAssetServiceConnector is still present but only used in tests. The paths below reflect the current architecture.

	=== Standalone path ===		=== Standalone path ===
Line 90:		Line 92:
	* [[OpenSimulator Internals/ROBUST Services]]		* [[OpenSimulator Internals/ROBUST Services]]
	* [[OpenSimulator Internals/Data Dictionaries]]		* [[OpenSimulator Internals/Data Dictionaries]]
			* [[OpenSimulator Internals/Asset Connector]]

Jwbshaw: fixed revised architecture

2026-06-21T09:13:09Z

fixed revised architecture

← Older revision		Revision as of 09:13, 21 June 2026
Line 54:		Line 54:

	== Example: Asset Get ==		== Example: Asset Get ==

			Note: In OpenSimulator 0.9.2, LocalAssetServiceConnector, RemoteAssetServiceConnector, and HGAssetBroker were replaced by a single module RegionAssetConnector. LocalAssetServiceConnector is still present but only used in tests. The paths below reflect the current architecture.

	=== Standalone path ===		=== Standalone path ===

	# Simulator calls Scene.AssetService.Get()		# Simulator calls Scene.AssetService.Get()
	# Routes to ~~LocalAssetServiceConnector~~.Get()		# Routes to RegionAssetConnector.Get()
	# Checks cache		# Checks cache
	# On miss, calls AssetService.Get()		# On miss, calls AssetService.Get() directly in-process
	# AssetService retrieves from persistent storage		# AssetService retrieves from persistent storage

Line 66:		Line 68:

	# Simulator calls Scene.AssetService.Get()		# Simulator calls Scene.AssetService.Get()
	# Routes to ~~RemoteAssetServiceConnector~~.Get()		# Routes to RegionAssetConnector.Get()
	# ~~Inherits from~~ OpenSim/Services/Connectors~~/AssetServiceConnector~~		# Delegates to AssetServicesConnector (OpenSim/Services/Connectors)
	# Makes HTTP GET to http://yourassetserver/assets/assetId		# Makes HTTP GET to http://yourassetserver/assets/assetId
	# Received by OpenSim/Server/Handlers/Asset/AssetServerConnector		# Received by OpenSim/Server/Handlers/Asset/AssetServerConnector
	# AssetServerGetHandler unpacks request, calls AssetService		# AssetServerGetHandler unpacks request, calls AssetService
	# Returns asset as XML on success, 404 on miss		# Returns asset as XML on success, 404 on miss

			=== HyperGrid path ===

			# Simulator calls Scene.AssetService.Get()
			# Routes to RegionAssetConnector.Get()
			# RegionAssetConnector determines if asset is local or foreign grid
			# Foreign: instantiates GridAssetClient for the foreign grid
			# Makes HTTP GET to foreign asset server
			# Asset copied to local asset table on retrieval -- same UUID, no link back

	----		----

Jwbshaw: first

2026-06-21T07:28:18Z

first

New page

= OpenSimulator Internals/Connector Architecture =

== Overview ==

The connector handles network calls transparently. Calling code does not need to know whether the service is local (standalone) or remote (grid mode) -- the connector abstracts that distinction.

In standalone mode the connector calls the service directly in-process. In grid mode it makes an HTTP call to ROBUST. Same interface either way.

----

== The Five Components ==

Up to five components are involved in connecting simulator code to a grid service.

{| class="wikitable"
! Component !! Location !! Description
|-
| Simulator code || OpenSimulator core or a module || Makes the initial service call to get or set data.
|-
| Simulator service connector || OpenSim/Region/CoreModules/ServiceConnectorsOut (outbound), ServiceConnectorsIn (inbound) || Two flavours: local (same process, standalone -- calls service directly) and remote (grid mode -- delegates to remote service connector for network call).
|-
| Remote service connector || OpenSim/Services/Connectors || Marshals data and makes the network call to the remote service. Not used for in-process connections.
|-
| Remote service handler || OpenSim/Server/Handlers || Unpacks the incoming network call and passes it to the service. Not used for in-process connections.
|-
| The service || OpenSim/Services/[ServiceName] (e.g. OpenSim/Services/AssetService) || Actually services the call and returns data.
|}

----

== Configuration ==

=== Standalone ===

Connectors and service in the same process:

[Modules]
AssetServices = "LocalAssetServicesConnector"

[AssetService]
LocalServiceModule = "OpenSim.Services.AssetService.dll:AssetService"

=== Grid ===

Service runs remotely:

[Modules]
AssetServices = "RemoteAssetServicesConnector"

[AssetService]
AssetServerURI = "http://myassetserver.com:8003"

----

== Example: Asset Get ==

=== Standalone path ===

# Simulator calls Scene.AssetService.Get()
# Routes to LocalAssetServiceConnector.Get()
# Checks cache
# On miss, calls AssetService.Get()
# AssetService retrieves from persistent storage

=== Grid path ===

# Simulator calls Scene.AssetService.Get()
# Routes to RemoteAssetServiceConnector.Get()
# Inherits from OpenSim/Services/Connectors/AssetServiceConnector
# Makes HTTP GET to http://yourassetserver/assets/assetId
# Received by OpenSim/Server/Handlers/Asset/AssetServerConnector
# AssetServerGetHandler unpacks request, calls AssetService
# Returns asset as XML on success, 404 on miss

----

== See Also ==

* [[OpenSimulator Internals/ROBUST Services]]
* [[OpenSimulator Internals/Data Dictionaries]]

← Older revision		Revision as of 23:25, 7 July 2026
Line 11:		Line 11:

	Region code calls only the interface. Which implementation is loaded depends on configuration ([Architecture] section of the ini files).		Region code calls only the interface. Which implementation is loaded depends on configuration ([Architecture] section of the ini files).

			Because every ROBUST service is stateless, each can be independently load-balanced or replicated without coordination between instances.

	See [[OpenSimulator Internals/ROBUST Services]] for the server-side service implementations.		See [[OpenSimulator Internals/ROBUST Services]] for the server-side service implementations.
Line 36:		Line 38:
	! Connector !! Service Interface !! Notes		! Connector !! Service Interface !! Notes
	\|-		\|-
	\| [[OpenSimulator Internals/Connector Architecture/Asset Connector]] \|\| IAssetService \|\| ~~Includes~~ server-side handler ~~detail. HG variant wraps with foreign asset server logic~~.		\| [[OpenSimulator Internals/Connector Architecture/Asset Connector]] \|\| IAssetService \|\| As of 0.9.2, the three region-side asset modules (LocalAssetServiceConnector, RemoteAssetServiceConnector, HGAssetBroker) were replaced by a single RegionAssetConnector. LocalAssetServiceConnector is retained for test use only. HGAssetBroker and RemoteAssetServiceConnector are no longer used in production. RegionAssetConnector behaviour is controlled by [AssetService] keys LocalGridAssetService and HypergridAssetService. See individual page for full detail including server-side handler code.
	\|-		\|-
	\| [[OpenSimulator Internals/Connector Architecture/GridUser Connector]] \|\| IGridUserService \|\| Tracks last position, login/logout timestamps, home region.		\| [[OpenSimulator Internals/Connector Architecture/GridUser Connector]] \|\| IGridUserService \|\| Tracks last position, login/logout timestamps, home region. Online status in GridUser is less accurate than in Presence, which is updated more frequently.
	\|-		\|-
	\| [[OpenSimulator Internals/Connector Architecture/Presence Connector]] \|\| IPresenceService \|\| Online status, session tracking, region assignment.		\| [[OpenSimulator Internals/Connector Architecture/Presence Connector]] \|\| IPresenceService \|\| Online status, session tracking, region assignment.
Line 70:		Line 72:
	* Gatekeeper Connector -- used to contact a foreign grid's Gatekeeper during HG destination resolution.		* Gatekeeper Connector -- used to contact a foreign grid's Gatekeeper during HG destination resolution.
	* HGAsset Connector -- used by HGInventoryAccessModule to fetch/push assets between grids (via HGAssetMapper).		* HGAsset Connector -- used by HGInventoryAccessModule to fetch/push assets between grids (via HGAssetMapper).

			Note: prior to 0.9.2, the HGAssetBroker region module handled the local/remote/foreign asset routing decision. It was retired in 0.9.2 and replaced by RegionAssetConnector. References to HGAssetBroker in older documentation and config examples are obsolete.

	These are documented in the individual connector pages above and in:		These are documented in the individual connector pages above and in: