TAPI Job internal functions (tapi_job_internal)

Overview

Auxiliary functions for internal use in TAPI Job

// global functions

rcf_rpc_server* tapi_job_get_rpcs(const tapi_job_t* job);
unsigned int tapi_job_get_id(const tapi_job_t* job);
void tapi_job_set_id(tapi_job_t* job, unsigned int id);
const char* tapi_job_get_ta(const tapi_job_t* job);
const char* tapi_job_get_name(const tapi_job_t* job);
void tapi_job_set_name(tapi_job_t* job, const char* name);
bool tapi_job_get_silent_pass(const tapi_job_t* job);

Detailed Documentation

Auxiliary functions for internal use in TAPI Job

Global Functions

rcf_rpc_server* tapi_job_get_rpcs(const tapi_job_t* job)

Get RPC server on which job was created. The job must have been created using RPC job factory, otherwise the function calls TEST_FAIL().

The function is primarily intended for internal usage.

Parameters:

job	Job instance handle
TEST_FAIL

Returns:

RPC server on which job was created

unsigned int tapi_job_get_id(const tapi_job_t* job)

Get internal ID of the job. The job must have been created using RPC job factory, otherwise the function calls TEST_FAIL().

The function is primarily intended for internal usage.

Parameters:

job	Job instance handle
TEST_FAIL

Returns:

Internal ID of the job

void tapi_job_set_id(tapi_job_t* job, unsigned int id)

Set internal ID of the job. The job must have been created using RPC job factory, otherwise the function calls TEST_FAIL().

The function is primarily intended for internal usage.

Parameters:

job	Job instance handle
id	ID to set to the `job`
TEST_FAIL

const char* tapi_job_get_ta(const tapi_job_t* job)

Get name of the Test Agent on which job was created. The job must have been created using CFG job factory, otherwise the function calls TEST_FAIL().

The function is primarily intended for internal usage.

Parameters:

job	Job instance handle
TEST_FAIL

Returns:

Name of the Test Agent on which job was created

const char* tapi_job_get_name(const tapi_job_t* job)

Get name of the job. The job must have been created using CFG job factory, otherwise the function calls TEST_FAIL().

The function is primarily intended for internal usage.

Parameters:

job	Job instance handle
TEST_FAIL

Returns:

Name of the job

void tapi_job_set_name(tapi_job_t* job, const char* name)

Set name of the job. The corresponding member of tapi_job_t should be freed when the job is not needed anymore. The job must have been created using CFG job factory, otherwise the function calls TEST_FAIL().

The function is primarily intended for internal usage.

Parameters:

job	Job instance handle
name	Name to set to the `job`
TEST_FAIL

bool tapi_job_get_silent_pass(const tapi_job_t* job)

Get value of the field that manages RPC calls muting.

The function is primarily intended for internal usage.

Parameters:

job	Job instance handle
TEST_FAIL

Returns:

Status code