PreEmptive Analytics Win32 Client
 All Classes Files Functions Variables Typedefs Macros
Public Member Functions | Static Public Attributes | List of all members
PAClient Class Reference

The primary public interface for the PreEmptive Analytics client. More...

Public Member Functions

DLL_PACLIENT PAClient ()
 Create a new client instance. More...
 
DLL_PACLIENT ~PAClient ()
 Delete the current client instance. More...
 
DLL_PACLIENT bool ApplicationStart (const Configuration *configuration, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 Starts the PreEmptive Analytics client. More...
 
DLL_PACLIENT bool ApplicationStart (const Configuration *configuration, const ExtendedKeys *keys)
 Starts the PreEmptive Analytics client. More...
 
DLL_PACLIENT void ApplicationStop (const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 Stops the PreEmptive Analytics client. More...
 
DLL_PACLIENT void ApplicationStop (const ExtendedKeys *keys)
 Stops the PreEmptive Analytics client. More...
 
DLL_PACLIENT void ExpirationWarningEvent (const wchar_t *id, const wchar_t *session=NULL, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 An expiriation warning message is created and is sent to the server. More...
 
DLL_PACLIENT void ExpirationWarningEvent (const wchar_t *id, const BinaryInfo *binary, const ExtendedKeys *keys=NULL)
 An expiriation warning message is created and is sent to the server. More...
 
DLL_PACLIENT void ExpirationWarningEvent (const wchar_t *id, const ExtendedKeys *keys)
 An expiriation warning message is created and is sent to the server. More...
 
DLL_PACLIENT void ExpiredEvent (const wchar_t *id, const wchar_t *session=NULL, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 An expiriation message is created and is sent to the server. More...
 
DLL_PACLIENT void ExpiredEvent (const wchar_t *id, const BinaryInfo *binary, const ExtendedKeys *keys=NULL)
 An expiriation message is created and is sent to the server. More...
 
DLL_PACLIENT void ExpiredEvent (const wchar_t *id, const ExtendedKeys *keys)
 An expiriation message is created and is sent to the server. More...
 
DLL_PACLIENT void FeatureStart (const wchar_t *name, const wchar_t *session=NULL, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 A feature start message is created and sent to the server. More...
 
DLL_PACLIENT void FeatureStart (const wchar_t *name, const BinaryInfo *binary, const ExtendedKeys *keys=NULL)
 A feature start message is created and sent to the server. More...
 
DLL_PACLIENT void FeatureStart (const wchar_t *name, const ExtendedKeys *keys)
 A feature start message is created and sent to the server. More...
 
DLL_PACLIENT void FeatureStop (const wchar_t *name, const wchar_t *session=NULL, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 A feature stop message is created and sent to the server. More...
 
DLL_PACLIENT void FeatureStop (const wchar_t *name, const BinaryInfo *binary, const ExtendedKeys *keys=NULL)
 A feature stop message is created and sent to the server. More...
 
DLL_PACLIENT void FeatureStop (const wchar_t *name, const ExtendedKeys *keys)
 A feature stop message is created and sent to the server. More...
 
DLL_PACLIENT void FeatureTick (const wchar_t *name, const wchar_t *session=NULL, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 A feature tick message is created and sent to the server. More...
 
DLL_PACLIENT void FeatureTick (const wchar_t *name, const BinaryInfo *binary, const ExtendedKeys *keys=NULL)
 A feature tick message is created and sent to the server. More...
 
DLL_PACLIENT void FeatureTick (const wchar_t *name, const ExtendedKeys *keys)
 A feature tick message is created and sent to the server. More...
 
DLL_PACLIENT const wchar_t * GetDefaultSession ()
 Returns the default session ID. More...
 
DLL_PACLIENT const wchar_t * GetMessageGroup ()
 Returns the message group ID. More...
 
DLL_PACLIENT bool IsApplicationStarted ()
 Has ApplicationStart() been successfully called? More...
 
DLL_PACLIENT void PerformanceProbe (const wchar_t *name, const wchar_t *session=NULL, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 A performance probe message is created using the FullData option setting and is sent to the server. More...
 
DLL_PACLIENT void PerformanceProbe (const wchar_t *name, const BinaryInfo *binary, const ExtendedKeys *keys=NULL)
 A performance probe message is created using the FullData option setting and is sent to the server. More...
 
DLL_PACLIENT void PerformanceProbe (const wchar_t *name, const ExtendedKeys *keys)
 A performance probe message is created using the FullData option setting and is sent to the server. More...
 
DLL_PACLIENT void ReportException (const ExceptionInfo *exception, const wchar_t *session=NULL, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL, const bool report_appcomponents=true)
 An exception report message is created and is sent to the server. More...
 
DLL_PACLIENT void ReportException (const ExceptionInfo *exception, const BinaryInfo *binary, const ExtendedKeys *keys=NULL)
 An exception report message is created and is sent to the server. More...
 
DLL_PACLIENT void ReportException (const ExceptionInfo *exception, const ExtendedKeys *keys)
 An exception report message is created and is sent to the server. More...
 
DLL_PACLIENT void ReportException (const ExceptionInfo &exception, const wchar_t *session=NULL, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL, const bool report_appcomponents=true)
 An exception report message is created and is sent to the server. More...
 
DLL_PACLIENT void ReportException (const ExceptionInfo &exception, const BinaryInfo *binary, const ExtendedKeys *keys=NULL)
 An exception report message is created and is sent to the server. More...
 
DLL_PACLIENT void ReportException (const ExceptionInfo &exception, const ExtendedKeys *keys)
 An exception report message is created and is sent to the server. More...
 
DLL_PACLIENT void SendMessages ()
 Request that queued data should be transmitted to the server immediately. More...
 
DLL_PACLIENT void SessionStart (const wchar_t *session, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 A session start message is created and sent to server. More...
 
DLL_PACLIENT void SessionStart (const wchar_t *session, const ExtendedKeys *keys)
 A session start message is created and sent to server. More...
 
DLL_PACLIENT void SessionStop (const wchar_t *session, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 A session stop message is created and sent to server. More...
 
DLL_PACLIENT void SessionStop (const wchar_t *session, const ExtendedKeys *keys)
 A session stop message is created and sent to server. More...
 
DLL_PACLIENT void SetLogLevel (int level)
 Controls the level of logging performed by the PAClient. More...
 
DLL_PACLIENT void SetOptIn (bool optIn=true)
 Allow the user of the application to control if analytics data is gathered. More...
 
DLL_PACLIENT void SetSendDisabled (bool sendDisabled=true)
 Prevent or allow messages to be sent to the server or stored locally. More...
 
DLL_PACLIENT void SystemProfile (const wchar_t *session=NULL, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 A system profile message is created using the FullData and OmitPersonalInfo option settings and sent to the server. More...
 
DLL_PACLIENT void SystemProfile (const BinaryInfo *binary, const ExtendedKeys *keys=NULL)
 A system profile message is created using the FullData and OmitPersonalInfo option settings and sent to the server. More...
 
DLL_PACLIENT void SystemProfile (const ExtendedKeys *keys)
 A system profile message is created using the FullData and OmitPersonalInfo option settings and sent to the server. More...
 
DLL_PACLIENT void TamperEvent (const wchar_t *session=NULL, const BinaryInfo *binary=NULL, const ExtendedKeys *keys=NULL)
 A tamper notification message is created and is sent to the server. More...
 
DLL_PACLIENT void TamperEvent (const BinaryInfo *binary, const ExtendedKeys *keys=NULL)
 A tamper notification message is created and is sent to the server. More...
 
DLL_PACLIENT void TamperEvent (const ExtendedKeys *keys)
 A tamper notification message is created and is sent to the server. More...
 

Static Public Attributes

static DLL_PACLIENT const int LOG_ERROR
 Indicates that only Error messages should be logged. More...
 
static DLL_PACLIENT const int LOG_INFO
 Indicates that Error, Warning, and Information messages should be logged. More...
 
static DLL_PACLIENT const int LOG_WARN
 Indicates that Error and Warning messages should be logged. More...
 

Detailed Description

The primary public interface for the PreEmptive Analytics client.

The general usage pattern is:

Constructor & Destructor Documentation

DLL_PACLIENT PAClient::PAClient ( )

Create a new client instance.

DLL_PACLIENT PAClient::~PAClient ( )

Delete the current client instance.

Member Function Documentation

DLL_PACLIENT bool PAClient::ApplicationStart ( const Configuration configuration,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

Starts the PreEmptive Analytics client.

Before the client system has been started any attempts to send messages of any type are ignored. If the client system is running, i.e. ApplicationStart() has previously been called and ApplicationStop() not yet called, then the start request is ignored.
Parameters
configurationa non-null Configuraiton instance used to define the configuration of the PAClient.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
Returns
true if the request was accepted an the PreEmptive Analytics client is now running
DLL_PACLIENT bool PAClient::ApplicationStart ( const Configuration configuration,
const ExtendedKeys keys 
)

Starts the PreEmptive Analytics client.

Before the client system has been started any attempts to send messages of any type are ignored. If the client system is running, i.e. ApplicationStart() has previously been called and ApplicationStop() not yet called, then the start request is ignored.
Parameters
configurationa non-null Configuraiton instance used to define the configuration of the PAClient.
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
Returns
true if the request was accepted and the PreEmptive Analytics client is now running
DLL_PACLIENT void PAClient::ApplicationStop ( const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

Stops the PreEmptive Analytics client.

This method halts the client system and releases all connections and resources used by it. To continue interaction with the client system ApplicationStart() will need to be called again: all other requests to the PAClient will be ignored. If the client system is not currently running then the request is ignored.
Parameters
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::ApplicationStop ( const ExtendedKeys keys)

Stops the PreEmptive Analytics client.

This method halts the client system and releases all connections and resources used by it. To continue interaction with the client system ApplicationStart() will need to be called again: all other requests to the PAClient will be ignored. If the client system is not currently running then the request is ignored.
Parameters
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::ExpirationWarningEvent ( const wchar_t *  id,
const wchar_t *  session = NULL,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

An expiriation warning message is created and is sent to the server.

This method is used to send an message when the application has determined that its license is about to expired. If the client system is not currently running then the request is ignored.
Parameters
ida GUID; a GUID issued by PreEmptive Solutions that identifies the generator of the message. If not provided then an "empty" GUID is used.
sessiona GUID; the ID of the session. If not provided then the default session ID is used.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::ExpirationWarningEvent ( const wchar_t *  id,
const BinaryInfo binary,
const ExtendedKeys keys = NULL 
)

An expiriation warning message is created and is sent to the server.

This method is used to send an message when the application has determined that its license is about to expired. If the client system is not currently running then the request is ignored.
Parameters
ida GUID; a GUID issued by PreEmptive Solutions that identifies the generator of the message. If not provided then an "empty" GUID is used.
binarya BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::ExpirationWarningEvent ( const wchar_t *  id,
const ExtendedKeys keys 
)

An expiriation warning message is created and is sent to the server.

This method is used to send an message when the application has determined that its license is about to expired. If the client system is not currently running then the request is ignored.
Parameters
ida GUID; a GUID issued by PreEmptive Solutions that identifies the generator of the message. If not provided then an "empty" GUID is used.
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::ExpiredEvent ( const wchar_t *  id,
const wchar_t *  session = NULL,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

An expiriation message is created and is sent to the server.

This method is used to send an message when the application has determined that its license has expired. If the client system is not currently running then the request is ignored.
Parameters
ida GUID; a GUID issued by PreEmptive Solutions that identifies the generator of the message. If not provided then an "empty" GUID is used.
sessiona GUID; the ID of the session. If not provided then the default session ID is used.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::ExpiredEvent ( const wchar_t *  id,
const BinaryInfo binary,
const ExtendedKeys keys = NULL 
)

An expiriation message is created and is sent to the server.

This method is used to send an message when the application has determined that its license has expired. If the client system is not currently running then the request is ignored.
Parameters
ida GUID; a GUID issued by PreEmptive Solutions that identifies the generator of the message. If not provided then an "empty" GUID is used.
binarya BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::ExpiredEvent ( const wchar_t *  id,
const ExtendedKeys keys 
)

An expiriation message is created and is sent to the server.

This method is used to send an message when the application has determined that its license has expired. If the client system is not currently running then the request is ignored.
Parameters
ida GUID; a GUID issued by PreEmptive Solutions that identifies the generator of the message. If not provided then an "empty" GUID is used.
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::FeatureStart ( const wchar_t *  name,
const wchar_t *  session = NULL,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

A feature start message is created and sent to the server.

A feature start indicates that an application feature has been started. If the client system is not currently running then the request is ignored. If name is not provided then the request is ignored.
Parameters
namea string; the name of the feature.
sessiona GUID; the ID of the session. If not provided then the default session ID is used.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
See Also
FeatureStop()
DLL_PACLIENT void PAClient::FeatureStart ( const wchar_t *  name,
const BinaryInfo binary,
const ExtendedKeys keys = NULL 
)

A feature start message is created and sent to the server.

A feature start indicates that an application feature has been started. If the client system is not currently running then the request is ignored. If name is not provided then the request is ignored.
Parameters
namea string; the name of the feature.
binarya BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
See Also
FeatureStop()
DLL_PACLIENT void PAClient::FeatureStart ( const wchar_t *  name,
const ExtendedKeys keys 
)

A feature start message is created and sent to the server.

A feature start indicates that an application feature has been started. If the client system is not currently running then the request is ignored. If name is not provided then the request is ignored.
Parameters
namea string; the name of the feature.
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
See Also
FeatureStop()
DLL_PACLIENT void PAClient::FeatureStop ( const wchar_t *  name,
const wchar_t *  session = NULL,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

A feature stop message is created and sent to the server.

A feature stop indicates that a previously started application feature has been started. If the client system is not currently running then the request is ignored. If name is not provided then the request is ignored.
Parameters
namea string; the name of the feature.
sessiona GUID; the ID of the session. If not provided then the default session ID is used.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
See Also
FeatureStart()
DLL_PACLIENT void PAClient::FeatureStop ( const wchar_t *  name,
const BinaryInfo binary,
const ExtendedKeys keys = NULL 
)

A feature stop message is created and sent to the server.

A feature stop indicates that a previously started application feature has been started. If the client system is not currently running then the request is ignored. If name is not provided then the request is ignored.
Parameters
namea string; the name of the feature.
binarya BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
See Also
FeatureStart()
DLL_PACLIENT void PAClient::FeatureStop ( const wchar_t *  name,
const ExtendedKeys keys 
)

A feature stop message is created and sent to the server.

A feature stop indicates that a previously started application feature has been started. If the client system is not currently running then the request is ignored. If name is not provided then the request is ignored.
Parameters
namea string; the name of the feature.
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
See Also
FeatureStart()
DLL_PACLIENT void PAClient::FeatureTick ( const wchar_t *  name,
const wchar_t *  session = NULL,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

A feature tick message is created and sent to the server.

A feature tick indicates that an application feature has been executed. If the client system is not currently running then the request is ignored. If name is not provided then the request is ignored.
Parameters
namea string; the name of the feature.
sessiona GUID; the ID of the session. If not provided then the default session ID is used.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::FeatureTick ( const wchar_t *  name,
const BinaryInfo binary,
const ExtendedKeys keys = NULL 
)

A feature tick message is created and sent to the server.

A feature tick indicates that an application feature has been executed. If the client system is not currently running then the request is ignored. If name is not provided then the request is ignored.
Parameters
namea string; the name of the feature.
binarya BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::FeatureTick ( const wchar_t *  name,
const ExtendedKeys keys 
)

A feature tick message is created and sent to the server.

A feature tick indicates that an application feature has been executed. If the client system is not currently running then the request is ignored. If name is not provided then the request is ignored.
Parameters
namea string; the name of the feature.
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT const wchar_t* PAClient::GetDefaultSession ( )

Returns the default session ID.

Used to retrieve the default session ID used for interoperability. This value can be passed to another PAClient implementation to instruct it to use this GUID as the default session ID.
Returns
the default session ID (a GUID). If the application is not running then null is returned.
DLL_PACLIENT const wchar_t* PAClient::GetMessageGroup ( )

Returns the message group ID.

Used to retrieve the message grop ID used for interoperability. This value can be passed to another PAClient implementation to instruct it to use this GUID as the message group ID.
Returns
the message group ID (a GUID). If the application is not running then null is returned.
DLL_PACLIENT bool PAClient::IsApplicationStarted ( )

Has ApplicationStart() been successfully called?

Returns
true if ApplicationStart() has been successfully called. false if ApplicationStart() has not been successfully called or ApplicationStop() has been called.
DLL_PACLIENT void PAClient::PerformanceProbe ( const wchar_t *  name,
const wchar_t *  session = NULL,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

A performance probe message is created using the FullData option setting and is sent to the server.

This method gathers performance related information while your application is executing.
Performance data collected includes:
  • CPU Utilization
  • Memory available
  • Memory used by current process
If the client system is not currently running then the request is ignored.
Parameters
namethe name for the location of the probe.
sessiona GUID; the ID of the session. If not provided then the default session ID is used.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::PerformanceProbe ( const wchar_t *  name,
const BinaryInfo binary,
const ExtendedKeys keys = NULL 
)

A performance probe message is created using the FullData option setting and is sent to the server.

This method gathers performance related information while your application is executing.
Performance data collected includes:
  • CPU Utilization
  • Memory available
  • Memory used by current process
If the client system is not currently running then the request is ignored.
Parameters
namethe name for the location of the probe.
binarya BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::PerformanceProbe ( const wchar_t *  name,
const ExtendedKeys keys 
)

A performance probe message is created using the FullData option setting and is sent to the server.

This method gathers performance related information while your application is executing.
Performance data collected includes:
  • CPU Utilization
  • Memory available
  • Memory used by current process
If the client system is not currently running then the request is ignored.
Parameters
namethe name for the location of the probe.
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::ReportException ( const ExceptionInfo exception,
const wchar_t *  session = NULL,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL,
const bool  report_appcomponents = true 
)

An exception report message is created and is sent to the server.

Parameters
exceptiona description of exception event
sessionA GUID; the ID of the session. If not provided then the default session ID is used.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
report_appcomponentsa boolean on if loaded modules should be reported on.
DLL_PACLIENT void PAClient::ReportException ( const ExceptionInfo exception,
const BinaryInfo binary,
const ExtendedKeys keys = NULL 
)

An exception report message is created and is sent to the server.

Parameters
exceptiona description of exception event
binarya BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::ReportException ( const ExceptionInfo exception,
const ExtendedKeys keys 
)

An exception report message is created and is sent to the server.

Parameters
exceptiona description of exception event
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::ReportException ( const ExceptionInfo exception,
const wchar_t *  session = NULL,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL,
const bool  report_appcomponents = true 
)

An exception report message is created and is sent to the server.

Parameters
exceptiona description of exception event
sessionA GUID; the ID of the session. If not provided then the default session ID is used.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
report_appcomponentsa boolean on if loaded modules should be reported on.
DLL_PACLIENT void PAClient::ReportException ( const ExceptionInfo exception,
const BinaryInfo binary,
const ExtendedKeys keys = NULL 
)

An exception report message is created and is sent to the server.

Parameters
exceptiona description of exception event
binarya BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::ReportException ( const ExceptionInfo exception,
const ExtendedKeys keys 
)

An exception report message is created and is sent to the server.

Parameters
exceptiona description of exception event
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::SendMessages ( )

Request that queued data should be transmitted to the server immediately.

DLL_PACLIENT void PAClient::SessionStart ( const wchar_t *  session,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

A session start message is created and sent to server.

A session represents a particular set of interactions such as a user working with a web service. If your application does not have the concept of multiple sessions you do not need to use SessionStart() or SessionStop() and can pass in null for session IDs.
Parameters
sessiona GUID; the ID of the session that is starting.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::SessionStart ( const wchar_t *  session,
const ExtendedKeys keys 
)

A session start message is created and sent to server.

A session represents a particular set of interactions such as a user working with a web service. If your application does not have the concept of multiple sessions you do not need to use SessionStart() or SessionStop() and can pass in null for session IDs.
Parameters
sessiona GUID; the ID of the session that is starting.
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::SessionStop ( const wchar_t *  session,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

A session stop message is created and sent to server.

A session represents a particular set of interactions such as a user working with a web service. If your application does not have the concept of multiple sessions you do not need to use SessionStart() or SessionStop() and can pass in null for session IDs.
Parameters
sessiona GUID; the ID of the session. If not provided then the default session ID is used.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::SessionStop ( const wchar_t *  session,
const ExtendedKeys keys 
)

A session stop message is created and sent to server.

A session represents a particular set of interactions such as a user working with a web service. If your application does not have the concept of multiple sessions you do not need to use SessionStart() or SessionStop() and can pass in null for session IDs.
Parameters
sessiona GUID; the ID of the session. If not provided then the default session ID is used.
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::SetLogLevel ( int  level)

Controls the level of logging performed by the PAClient.

The PAClient may generate messages that will log information or exceptional conditions. By default only Error messages are logged. Use this method to control what items are logged.
Parameters
levelone of LOG_INFO, LOG_WARN, LOG_ERROR.
DLL_PACLIENT void PAClient::SetOptIn ( bool  optIn = true)

Allow the user of the application to control if analytics data is gathered.

This method allows the user to change the "opt-in" state of the applications analytics gathering at runtime. When the user has opted out of analytics gathering then requests to generate new messages are ignored. Messages that have already been gather and are stored in memory or in local storage will still be sent.
Parameters
optIntrue to allow analytics data to be gathered, or false to prevent it from being gathered.
DLL_PACLIENT void PAClient::SetSendDisabled ( bool  sendDisabled = true)

Prevent or allow messages to be sent to the server or stored locally.

When send is disabled messaged will be queued in memory and will not be sent to the server or stored locally. Messages may be dropped if the queue reaches it maximum size.
Parameters
sendDisabledtrue to prevent messages to be sent, false to allow messages to be sent or stored.
DLL_PACLIENT void PAClient::SystemProfile ( const wchar_t *  session = NULL,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

A system profile message is created using the FullData and OmitPersonalInfo option settings and sent to the server.

This method gathers and send information about the system your application is running on.
The following kinds of system data is gathered:
  • Processors - Number of processors, clock speeds, manufacturer, and processor ID
  • Logical Disks - Number of logical disks, volume name, size, free space, file system
  • Memory - Speed, capacity
  • Network Adapters - IP address, MAC address
  • Domain - Domain name and role
  • Display - Name, refresh rate, vertical and horizontal resolution
  • Video - Name, memory size, color depth
  • Terminal Services - Connections allowed
  • Sound - Name, manufacturer
  • Modem - Model, device type
If the client system is not currently running then the request is ignored.
Parameters
sessiona GUID; the ID of the session. If not provided then the default session ID is used.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::SystemProfile ( const BinaryInfo binary,
const ExtendedKeys keys = NULL 
)

A system profile message is created using the FullData and OmitPersonalInfo option settings and sent to the server.

This method gathers and send information about the system your application is running on.
The following kinds of system data is gathered:
  • Processors - Number of processors, clock speeds, manufacturer, and processor ID
  • Logical Disks - Number of logical disks, volume name, size, free space, file system
  • Memory - Speed, capacity
  • Network Adapters - IP address, MAC address
  • Domain - Domain name and role
  • Display - Name, refresh rate, vertical and horizontal resolution
  • Video - Name, memory size, color depth
  • Terminal Services - Connections allowed
  • Sound - Name, manufacturer
  • Modem - Model, device type
If the client system is not currently running then the request is ignored.
Parameters
binarya BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::SystemProfile ( const ExtendedKeys keys)

A system profile message is created using the FullData and OmitPersonalInfo option settings and sent to the server.

This method gathers and send information about the system your application is running on.
The following kinds of system data is gathered:
  • Processors - Number of processors, clock speeds, manufacturer, and processor ID
  • Logical Disks - Number of logical disks, volume name, size, free space, file system
  • Memory - Speed, capacity
  • Network Adapters - IP address, MAC address
  • Domain - Domain name and role
  • Display - Name, refresh rate, vertical and horizontal resolution
  • Video - Name, memory size, color depth
  • Terminal Services - Connections allowed
  • Sound - Name, manufacturer
  • Modem - Model, device type
If the client system is not currently running then the request is ignored.
Parameters
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::TamperEvent ( const wchar_t *  session = NULL,
const BinaryInfo binary = NULL,
const ExtendedKeys keys = NULL 
)

A tamper notification message is created and is sent to the server.

This method is used to send an temper message when the application has determined that it has been modified. If the client system is not currently running then the request is ignored.
Parameters
sessionA GUID; the ID of the session. If not provided then the default session ID is used.
binaryan optional BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::TamperEvent ( const BinaryInfo binary,
const ExtendedKeys keys = NULL 
)

A tamper notification message is created and is sent to the server.

This method is used to send an temper message when the application has determined that it has been modified. If the client system is not currently running then the request is ignored.
Parameters
binarya BinaryInfo instance used to send additional information about the caller of the method to the PreEmptive Analytics server.
keysan optional ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.
DLL_PACLIENT void PAClient::TamperEvent ( const ExtendedKeys keys)

A tamper notification message is created and is sent to the server.

This method is used to send an temper message when the application has determined that it has been modified. If the client system is not currently running then the request is ignored.
Parameters
keysan ExtendedKeys instance used to send additional information to the PreEmptive Analytics server.

Member Data Documentation

DLL_PACLIENT const int PAClient::LOG_ERROR
static

Indicates that only Error messages should be logged.

See Also
SetLogLevel(int)
DLL_PACLIENT const int PAClient::LOG_INFO
static

Indicates that Error, Warning, and Information messages should be logged.

See Also
SetLogLevel(int)
DLL_PACLIENT const int PAClient::LOG_WARN
static

Indicates that Error and Warning messages should be logged.

See Also
SetLogLevel(int)