Server

Scaleform::GFx::AMP

Scaleform::GFx::AMP::Server

Declaration

class Server : public RefCountBase<Server, StatAmp_Server>, public AmpServer;

Description

AMP Server encapsulates the communication of a Scaleform application with an AMP client. This is a singleton that can be easily accessed throughout Scaleform. The object has several functions; it

- keeps track of statistics per frame

- manages the socket connection with the client

- handles received messages.

The server needs to be thread-safe, as it can be accessed from anywhere in Scaleform.

AMP::Server implements the Scaleform::AmpServer interface. This abstraction enables the Kernel to update AMP server without the Kernel having dependencies on Scaleform and AMP. Scaleform::DefaultAmpServer is a class that trivially implements AmpServer, for projects that do not initialize an AMP Server.

Methods

Method	Description
EndPlatformEvent
SetRenderer	Sets the renderer to be profiled (only one supported).
StartPlatformEvent
AddImage	Adds an image resource to the list of images reported by AMP.
AddLoader	Adds a loader to the list of active loaders.
AddLoadProcess	Called by Scaleform whenever a load process is created.
AddMovie	Adds a movie to the list of movies to be profiled.
AddSound	Adds to the total memory that AMP reports as used for sound.
AddSourceFile	Associates an ActionScript source code file with a handle, for later look up.
AddStrokes	Adds to the number of strokes that AMP reports in the rendering graph.
AddSwf	Creates a new entry in the SWD map.
AdvanceFrame	Advances the frame and needs to be called once per frame by the application.
CloseConnection	Closes the socket connection between the AMP server and the AMP client.
DecrementFontOptRead	Decrements the counter for text fields with AA for readability.
FindMovieByHeap	Used to find an instance of Movie by using memory heap
GetCurrentState	Retrieves the current state of the AMP server.
GetDisplayStats	Returns the renderer statistics.
GetNextSwdHandle	Retrieves the handle of the SWF file.
GetProfileLevel	Returns the level of function profiling.
GetSwdFilename	Retrieves the SWF file name for a given handle.
GetSwdId	Retrieves the SWD debug Id for a given handle.
HandleAppControl	Handles an application control request message by forwarding it to the callback object.
HandleImageRequest	Handles a request to load an image file.
HandleNextMessage	Called from the application to handle new socket messages.
HandleObjectsReportRequest	Generates an objects report that shows all ActionScript objects and the links between them.
HandleSourceRequest	Handles a request from AMP for an ActionScript source code file.
HandleSwdRequest	Handles the request to load the SWD file.
HandleFontRequest	Handles a request to send the font cache texture to AMP client.
HandleInitState	Updates the server with the AMP profiling settings to be used immediately upon connection.
IncrementFontFailures	Called by the Scaleform renderer whenever a glyph fails to allocate and is thus replaced by a vector representation.
Init	Initializes the singleton for communication with AMP.
IsEnabled	Determines whether the AMP server is in enabled/disabled state.
IsFunctionAggregation	If true, adds up all the function calls that have been made from the same calling function.
IsInstructionProfiling	Returns whether or not instruction profiling is active.
IsInstructionSampling	Returns whether or not instruction sampling is used for instruction profiling.
IsPaused	Determines whether the AMP server is in a paused state.
IsProfiling	Determines whether frame profiling is enabled or not.
IsValidConnection	Determines whether there is a valid socket connection between the AMP Server and the AMP client.
OpenConnection	Opens a socket connection between the AMP sever and the client.
RemoveImage	Removes an image resource from the list of images reported by AMP.
RemoveLoader	Removes a loader from the list of active loaders.
RemoveLoadProcess	Called by Scaleform whenever a load process is finished.
RemoveMovie	Removes a movie from the list of movies to be profiled.
IncrementFontOptRead	Increments the counter for text fields with AA for readability.
RemoveSound	Removes from the total memory that the AMP reports as used for sound.
RemoveStrokes	Removes from the number of strokes that AMP reports in the rendering graph.
SendAppControlCaps	Sends the supported AMP capabilities (for example, wireframe mode) to the AMP client.
SendCurrentState	Sends the current state of the AMP server to the AMP client so that UI can be properly updated.
SendLog	SendLog sends a log message to the AMP client.
SetAaMode	Sets the edge anti-aliasing modes in the Scaleform application.
SetAppControlCallback	Sets the custom callback that handles application-specific control messages.
SetAppControlCaps	Sets the AMP capabilities supported by the current Scaleform application.
SetBroadcastPort	Sets the port where UDP broadcast messages are sent and received.
MovieAdvance	Called from movie advance thread.
SetConnectedApp	Sets the name of the Scaleform application connected to the AMP.
SetConnectionWaitTime	Sets a wait time for connecting with the AMP server.
SetCurrentLocale	Sets the current locale information of the Scaleform application.
SetCurveTolerance	Sets the curve tolerance in the Scaleform application.
SetHeapLimit	Sets the limit on the memory heap allocated for the AMP server.
SetInitSocketLib	Initializes the socket library to be used by the AMP for communication.
SetListeningPort	Sets the port for the socket connection between the AMP and Scaleform.
SetMemReports	Turns on or off the detailed memory reporting.
SetProfileLevel	Sets the level of function profiling.
SetSocketImplFactory	Sets the AMP socket implementation factory for external socket implementation.
SetStrokeType	Sets the stroke type in the GFx application.
ToggleInternalStatRecording	Starts/stops recording of statistics for display when not connected to AMP server.
Uninit	Un-initializes the singleton after communication with AMP.
UpdateState	Updates the state of the AMP and sends it to AMP.

File

Amp_Server.h