com.prosyst.profiler.api
Class ProfilerAPI

java.lang.Object
  extended by com.prosyst.profiler.api.ProfilerAPI

public final class ProfilerAPI
extends java.lang.Object

Version:
5.0
Author:
Ivo Karabashev

Field Summary
static int API_ERR_API_NOT_ENABLED
          Return code: API should be enabled from the command line.
static int API_ERR_CANT_CONNECT
          Return code: Could not connect to host.
static int API_ERR_OK
          Return code: No error has occurred.
static int API_ERR_UNKNOWN_CMD
          Return code: Unknown command.
 
Method Summary
static int prof_connect(java.lang.String aHostname, short aPort)
          Connects to host name on given port.
static int prof_execute_cmd(int aCmd, int aParam1, int aParam2, int aParam3)
          Executes command with given parameters.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

API_ERR_API_NOT_ENABLED

public static final int API_ERR_API_NOT_ENABLED
Return code: API should be enabled from the command line.

See Also:
Constant Field Values

API_ERR_CANT_CONNECT

public static final int API_ERR_CANT_CONNECT
Return code: Could not connect to host.

See Also:
Constant Field Values

API_ERR_OK

public static final int API_ERR_OK
Return code: No error has occurred.

See Also:
Constant Field Values

API_ERR_UNKNOWN_CMD

public static final int API_ERR_UNKNOWN_CMD
Return code: Unknown command.

See Also:
Constant Field Values
Method Detail

prof_connect

public static int prof_connect(java.lang.String aHostname,
                               short aPort)
Connects to host name on given port.

Parameters:
aHostname - host to connect to
aPort - port number
Returns:
error code, see API_ERR_*

prof_execute_cmd

public static int prof_execute_cmd(int aCmd,
                                   int aParam1,
                                   int aParam2,
                                   int aParam3)
Executes command with given parameters. The caller is blocked until the front-end is connected. If the command has less than 3 parameters arbitrary values can be used for the extra arguments.

Parameters:
aCmd - command to be executed, see IProfilerCommands.PROF_CMD_*
aParam1 - parameter 1 for the command
aParam2 - parameter 2 for the command
aParam3 - parameter 3 for the command
Returns:
error code, see API_ERR_*