@spec call(t(), message :: term(), timeout :: non_neg_integer() | :infinity) ::
  response :: term()

Makes a synchronous call to CNode and waits for its reply.

The CNode is supposed to send back a {cnode, response} tuple where cnode is the node name of CNode. If the response doesn't come in within timeout, error is raised.

Messages are exchanged directly (without interacting with CNode's associated server).

@spec monitor(t()) :: reference()

Starts monitoring CNode from the calling process.

@spec send(t(), message :: term()) :: :ok

Sends a message to cnode.

The message is exchanged directly (without interacting with CNode's associated server).

Spawns and connects to CNode cnode_name from application of calling module.

See Bundlex.CNode.start/2 for more details.

@spec start(app :: atom(), native_name :: atom()) :: on_start_t()

Works the same way as start_link/2, but does not link to CNode's associated server.

Spawns and connects to CNode cnode_name from application of calling module.

See Bundlex.CNode.start_link/2 for more details.

@spec start_link(app :: atom(), native_name :: atom()) :: on_start_t()

Spawns and connects to CNode cnode_name from application app.

The CNode is passed the following command line arguments:

• host name,
• alive name,
• node name,
• creation number.

After CNode startup, these parameters should be passed to ei_connect_xinit function, and CNode should be published and await connection. Once the CNode is published, it should print a line starting with ready to the standard output and flush the standard output to avoid the line being buffered.

Under the hood, this function starts an associated server, which is responsible for monitoring the CNode and monitoring calling process to be able to do proper cleanup upon a crash. On startup, the server does the following:

1. Makes current node distributed if it is not done yet (see Node.start/3).
2. Assigns CNode a unique name.
3. Starts CNode OS process using Port.open/2.
4. Waits (at most 5 seconds) until a line ready is printed out (this line is captured and not forwarded to the stdout).
5. Connects to the CNode.

The erlang cookie is passed using the BUNDLEX_ERLANG_COOKIE an environment variable.

@spec stop(t()) :: :ok | {:error, :disconnect_cnode}

Disconnects from CNode.

It is the responsibility of the CNode to exit upon connection loss.