View source for OpenSim.Region.DataSnapshot

=== DataSnapshotManager ===
This is the 'main' class for the module - it handles registering the IDataSnapshotProvider objects, creates the DataRequestHandler, and contains functions for generating snapshots. Notable functions:

* Initialise - Obtained from IRegionModule. Checks if the config is loaded, and adds each scene being simulated to it's internal list of regions to scrape for data.
* PostInitialise - The second most important function. Registers the timer callback, and searches the containing Assembly for IDataSnapshotProvider objects. Creates an IDataSnapshotProvider for each Scene and IDataSnapshotProvider combination. When the format and interface stabilises, we can then let this start checking other Assemblies for IDataSnapshotProviders. Then it makes the DataRequestHandler object and hands it the first scene. Finally, it checks to see if it needs to ping any external servers (as determined by configuration).
* Snapshot (private) - Spits out an XmlDocument from a Scene. Each XmlDocument can be sent directly as a response to a data request, but GetSnapshot can also merge them into a single response for every Scene being simulated by the host.
* GetSnapshot - Called from DataSnapshotManager. Should really be a part of DataRequestHandler.
* MakeRegionNode - Creates some of the XML in the format, would be in a IDataSnapshotProvider but currently the way their output goes into the format doesn't mesh with the interface well. Might want to rework the format later or something.
* NotifyDataServices - Responsible for pinging an external server defined in our configuration options.
* SnapshotTimerCallback - Notable for being useless. All it does is call MakeNewSnapshot. If you want anything else to happen when the snapshot timer elapses, add it here. I really should have just added MakeNewSnapshot to the timer directly.
* GetErrorMessage - Makes an error for GetSnapshot in case of an exception (missing file, etc)
* GetGridSnapshotData - Takes key-value pairs from GridData and makes it into XML, populated during the first Initialise call.
* GetRegionCategory - Helper function, only notable because originally when the Scene had no Mature or PG flag set it would return "PN Testing Sandbox", aka griefer heaven. Now returns a completely boring "Unknown", hence the comment.

...I think that's everything worth mentioning.