Test Script Execution Adapter API |
The TSEA API includes the following calls.
SessionClose()
Closes a TSEA session.
SessionGetOption()
Gets TSEA session options.
SessionOpen()
Opens a TSEA session.
SessionSetOption()
Sets TSEA session options.
TaskAbort()
Aborts a task.
TaskClose()
Closes a TSEA task.
TaskCreate()
Opens a TSEA task.
TaskExecute()
Executes a task.
TaskGetOption()
Gets TSEA task options.
TaskSetOption()
Sets TSEA task options.
TSEAError()
Gets TSEA error information.
s32SessionClose
(SessionHandlesession
)
session
The handle of the TSEA session to close.
TSEE makes this call when the last script of a playback request has completed. Your TSEA should perform any cleanup necessitated by the run.
Gets the value of a session option.
s32SessionGetOption
(SessionHandlesession
, char *optname
, void *optval
, s32len
)
SessionHandleSessionOpen
(char *hostname
, u16port
, s32strandID
, char **message
)
On success, return to the TSEE a unique session identifier of type SessionHandle
. On failure, return NULL. If NULL is returned, the failure is logged.
Sets the value of a session option.
s32SessionSetOption
(SessionHandlesession
, char *optname
, void *optval
, s32len
)
session
The session handle, returned by
SessionOpen(
).
optname
The session option whose value is to be set.
optval
The new value of
optname
.
len
The size of buffer
optval
.
s32TaskAbort
(TaskHandletask
)
task
The handle of the TSEA task to abort.
The TSEE makes this call (from another thread) to abort a task. Your TSEA should stop the task run as soon as possible and return a value greater than 0 indicating that the task has been aborted.
TaskClose()
, TaskCreate()
, TaskExecute()
s32TaskClose
(TaskHandletask
)
task
The handle of the TSEA task to close.
The TSEE makes this call when a task completes. Your TSEA should perform any cleanup necessitated by the task execution.
TaskAbort()
, TaskCreate()
, TaskExecute()
TaskHandleTaskCreate
(SessionHandlesession
, TaskTypetype
, char *sourcelocation
, char *testScriptId
)
On success, return to the TSEE a unique task identifier of type TaskHandle
. On failure, return NULL.
TaskAbort()
, TaskClose()
, TaskExecute()
s32TaskExecute
(TaskHandletask
)
task
The handle of the TSEA task to execute.
The TSEE makes this call to execute a task. Your TSEA should return 0 if the task completes successfully or a number greater than 0 if the task fails.
TaskAbort()
, TaskClose()
, TaskCreate()
Gets the value of a task option.
s32TaskGetOption
(TaskHandletask
, char *optname
, void *optval
, s32len
)
Sets the value of a task option.
s32TaskSetOption
(TaskHandletask
, char *optname
, void *optval
, s32len
)
task
The task handle, returned by
SessionOpen(
).
optname
The task option whose value is to be set.
optval
The new value of
optname
.
len
The size of buffer
optval
.
Gets a message following an error.
s32TSEAError
(SessionHandle session, char **message
)
session
The session handle, returned by
SessionOpen(
).
message
String explaining the cause of a TSEA call failure.
The TSEE makes this call whenever a TSEA call returns a value greater than 0. Your TSEA should allocate a message buffer for each open session and supply a message indicating the cause of a failure.
Rational TestManager Extensibility Reference | Rational Software Corporation |
Copyright (c) 2003, Rational Software Corporation | http://www.rational.com support@rational.com info@rational.com |