ESP SDK C API
Functions
Project Deployment Information
Project

Functions

ESPAPICALL const EspDeploymentesp_project_get_deployment (const EspProject *project, EspError *error)
ESPAPICALL int32_t esp_deployment_get_active_active (const EspDeployment *deployment, char *aa, int32_t *size, EspError *error)
ESPAPICALL int32_t esp_deployment_get_role (const EspDeployment *deployment, char *role, int32_t *size, EspError *error)
ESPAPICALL int32_t esp_deployment_get_instance_id (const EspDeployment *deployment, char *id, int32_t *size, EspError *error)
ESPAPICALL int32_t esp_deployment_get_instance_index (const EspDeployment *deployment, int32_t *index, EspError *error)
ESPAPICALL int32_t esp_deployment_get_host (const EspDeployment *deployment, char *host, int32_t *size, EspError *error)
ESPAPICALL int32_t esp_deployment_get_port (const EspDeployment *deployment, int32_t *port, EspError *error)
ESPAPICALL int32_t esp_deployment_get_sql_port (const EspDeployment *deployment, int32_t *sql_port, EspError *error)
ESPAPICALL int32_t esp_deployment_get_data_host (const EspDeployment *deployment, char *data_host, int32_t *size, EspError *error)
ESPAPICALL int32_t esp_deployment_get_data_port (const EspDeployment *deployment, int32_t *data_port, EspError *error)
ESPAPICALL int32_t esp_deployment_get_pid (const EspDeployment *deployment, int32_t *pid, EspError *error)
ESPAPICALL int32_t esp_deployment_is_bigendian (const EspDeployment *deployment, int32_t *big_endian, EspError *error)
ESPAPICALL int32_t esp_deployment_get_address_size (const EspDeployment *deployment, int32_t *address_size, EspError *error)
ESPAPICALL int32_t esp_deployment_get_date_size (const EspDeployment *deployment, int32_t *date_size, EspError *error)
ESPAPICALL int32_t esp_deployment_get_money_precision (const EspDeployment *deployment, int32_t *precision, EspError *error)

Function Documentation

ESPAPICALL int32_t esp_deployment_get_active_active ( const EspDeployment deployment,
char *  aa,
int32_t *  size,
EspError *  error 
)

Is the project running in active-active mode?

Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_address_size ( const EspDeployment deployment,
int32_t *  address_size,
EspError *  error 
)
Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_data_host ( const EspDeployment deployment,
char *  data_host,
int32_t *  size,
EspError *  error 
)
Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_data_port ( const EspDeployment deployment,
int32_t *  data_port,
EspError *  error 
)
Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_date_size ( const EspDeployment deployment,
int32_t *  date_size,
EspError *  error 
)
Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_host ( const EspDeployment deployment,
char *  host,
int32_t *  size,
EspError *  error 
)
Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_instance_id ( const EspDeployment deployment,
char *  id,
int32_t *  size,
EspError *  error 
)
Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_instance_index ( const EspDeployment deployment,
int32_t *  index,
EspError *  error 
)
Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_money_precision ( const EspDeployment deployment,
int32_t *  precision,
EspError *  error 
)
Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_pid ( const EspDeployment deployment,
int32_t *  pid,
EspError *  error 
)

Not valid for standalone projects.

Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_port ( const EspDeployment deployment,
int32_t *  port,
EspError *  error 
)
Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_role ( const EspDeployment deployment,
char *  role,
int32_t *  size,
EspError *  error 
)
Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_get_sql_port ( const EspDeployment deployment,
int32_t *  sql_port,
EspError *  error 
)

Not valid for standalone projects.

Parameters:
deploymentEspDeployment to query
ESPAPICALL int32_t esp_deployment_is_bigendian ( const EspDeployment deployment,
int32_t *  big_endian,
EspError *  error 
)
Returns:
0 on success.
Parameters:
deploymentEspDeployment to query
ESPAPICALL const EspDeployment* esp_project_get_deployment ( const EspProject project,
EspError *  error 
)

Returns the runtime deployment information for the connected project. If there is no error, the returned information is valid at the time the information is returned and remains valid until the project remains connected. No connectivity check is performed when retrieving the data components of an EspDeployment. User code for monitoring connectivity should retrieve the EspDeployment object every time it needs information.

NOTE - not all members of EspDeployment are valid for standalone projects.

Parameters:
projectEspProject for which to retrieve the deployment
 All Classes Variables