OpenSim::Framework::Communications::Cache::UserProfileCacheService Class Reference

Holds user profile information and retrieves it from backend services. More...

List of all members.

Public Member Functions
	UserProfileCacheService (CommunicationsManager commsManager, LibraryRootFolder libraryRootFolder)
	Constructor.
void	AddNewUser (UUID userID)
	A new user has moved into a region in this instance so retrieve their profile from the user service.
bool	RemoveUser (UUID userId)
	Remove this user's profile cache.
void	RequestInventoryForUser (UUID userID)
	Request the inventory data for the given user. This will occur asynchronously if running on a grid.
CachedUserInfo	GetUserDetails (UUID userID)
	Get cached details of the given user. If the user isn't in cache then the user is requested from the profile service.
void	PreloadUserCache (UUID userID, UserProfileData userData)
	Preloads User data into the region cache. Modules may use this service to add non-standard clients.
Public Attributes
readonly InventoryFolderImpl	LibraryRoot
	The root library folder.

---

Detailed Description

Holds user profile information and retrieves it from backend services.

---

Constructor & Destructor Documentation

OpenSim::Framework::Communications::Cache::UserProfileCacheService::UserProfileCacheService	(	CommunicationsManager	commsManager,
		LibraryRootFolder	libraryRootFolder
	)			[inline]

Constructor.

Parameters:

	commsManager
	libraryRootFolder

---

Member Function Documentation

void OpenSim::Framework::Communications::Cache::UserProfileCacheService::AddNewUser

(

UUID

userID

)

[inline]

A new user has moved into a region in this instance so retrieve their profile from the user service.

It isn't strictly necessary to make this call since user data can be lazily requested later on. However, it might be helpful in order to avoid an initial response delay later on

Parameters:

userID

bool OpenSim::Framework::Communications::Cache::UserProfileCacheService::RemoveUser

(

UUID

userId

)

[inline]

Remove this user's profile cache.

Parameters:

userID

Returns:

true if the user was successfully removed, false otherwise

void OpenSim::Framework::Communications::Cache::UserProfileCacheService::RequestInventoryForUser

(

UUID

userID

)

[inline]

Request the inventory data for the given user. This will occur asynchronously if running on a grid.

Parameters:

	userID
	userInfo

CachedUserInfo OpenSim::Framework::Communications::Cache::UserProfileCacheService::GetUserDetails

(

UUID

userID

)

[inline]

Get cached details of the given user. If the user isn't in cache then the user is requested from the profile service.

Parameters:

userID

Returns:

null if no user details are found

void OpenSim::Framework::Communications::Cache::UserProfileCacheService::PreloadUserCache	(	UUID	userID,
		UserProfileData	userData
	)			[inline]

Preloads User data into the region cache. Modules may use this service to add non-standard clients.

Parameters:

	userID
	userData

---

Member Data Documentation

readonly InventoryFolderImpl OpenSim::Framework::Communications::Cache::UserProfileCacheService::LibraryRoot

The root library folder.

---

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

• /home/sdague/opensim-docs/OpenSim/Framework/Communications/Cache/UserProfileCacheService.cs

---