Connection Module

The "connection" module is a module that manages the functions for performing remote execution.

Attention

It is a dedicated remote execution module that is included in the "Plugin package for Remote Execution".

Unlike other modules, the return value of the Connection Module is not an associative array.
It can be an integer type or with no return value.

Module name

cri.atomcraft.criatomcraft_api_lib

The following functions are defined as:

Function	Description
initialize	Initializes the connection function
finalize	Terminates the connection function
connect	Connects with CRI Atom Craft
disconnect	Disconnects with CRI Atom Craft
get_status	Obtains the connection status with CRI Atom Craft

initialize

Initializes the connection function.
Initialization is required before using the connection function for remote execution.

Format

result = initialize()

Input parameter

None

Return value

Name	Value
result	0 if succeed, non-zero value if failed

---

finalize

Terminates the connection function.

Format

finalize()

Input parameter

None

Return value

None

---

connect

Connects with CRI Atom Craft.

Format

result = connect(ip_address, port_number)

Input parameter

Name	Value
ip_address	IP address of CRI Atom Craft
port_number	Port number used for connection

Return value

Name	Value
result	0 if succeed, non-zero value if failed

---

disconnect

Disconnects with CRI Atom Craft.

Format

disconnect()

Input parameter

None

Return value

None

---

get_status

Obtains the connection status with CRI Atom Craft.

Format

result = get_status()

Input parameter

None

Return value

Name	Value
result	0 if connected, non-zero value if not connected