Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The LUA engine of the NETx BMS Core Server provides different runtime functions for network communication, e.g. e-mail, TCP, or FTP. In order to correctly send e-mails, the outgoing SMTP server has to be configured within the System Configuration file (cf. Section 4.2.2.5).

Description

Signature

xcon.Close (string)

Closes a connection.

Parameters

...

Return

None.

Description

Signature

xcon.Create (string, number, string, number, string, number)

This function can be used to create a socket in LUA.

Parameters

...

Return

None.

Description

Signature

xcon.CreateCOM (string, string, number, number, number, number, number, number)

This function can be used to create a serial connection in LUA.

Parameters

...

Return

None.

Description

Signature

bool xcon.CreateFTP (string, string, number, string, string)

This function creates an FTP client socket.

Parameters

...

Return

...

Description

Signature

xcon.CreateHTTP (string)

This function can be used to create an HTTP connection in LUA.

Parameters

...

Return

None.

Description

Signature

xcon.CreateTCP (string, string, number, string, number)

This function can be used to create a TCP socket in LUA.

Parameters

...

Return

None.

Description

Signature

xcon.CreateRSS (string)

This function can be used to create an RSS feed in LUA.

Parameters

...

Return

None.

Description

Signature

xcon.CreateUDP (string, string, number, string, number)

This function can be used to create a UDP socket in LUA.

Parameters

...

Return

None.

Description

Signature

bool xcon.Download (string, string, number)

This function initiates an asynchronous FTP download. If a download is already taking place on this connection (identified by host, port, user, and password), the transfer is enqueued and commenced once the current transfer is finished. Provide _OnDoneEvent and _OnErrorEvent callback functions to be notified on transfer completion and errors (ref. section 4.6.11).

Parameters

...

Return

...

Description

Signature

bool xcon.IsConnected (string)

This function determines whether the connection is established.

Parameters

...

Return

...

Description

Signature

bool xcon.Send (string, string, number)

This function can be used to send data via an established connection.

Parameters

...

Return

...

Description

Signature

bool xcon.SendTo (string, string, number, string, number)

This function can be used to send data via an established connection.

Parameters

...

Return

...

Description

Signature

xcon.SendAdminEmail (string, string, string)

This function can be used to directly send an e-mail to the specified admin e-mail address.

Parameters

...

Return

None.

Description

Signature

xcon.SendEmailTo (string, string, string, string)

This function can be used to directly send an e-mail within LUA.

Parameters

...

Return

None.

Description

Signature

bool xcon.SendHex (string, string)

Sends binary data given as hex-bytes via an established connection.

Parameters

...

Return

...

Description

Signature

bool xcon.SendTextTo (string, string, string, number)

Sends binary data given as hex-bytes via an established connection.

Parameters

...

Return

...

Description

Signature

xcon.SendSystemEmail (string, string, string)

This function can be used to directly send an e-mail to the specified systen e-mail address.

Parameters

...

Return

None.

Description

Signature

bool xcon.SendText (plain string over socket connection) (string, string)

This function can be used to send data via an established connection.

Parameters

...

Return

...

Description

Signature

bool xcon.SendText (HTTP POST with JSON string) (string, string, number, number, string)

This function can be used to send data via an established connection.

Parameters

...

Return

...

Description

Signature

bool xcon.SendText (HTTP POST with JSON string and MIME type provided) (string, string, number, number, string, string)

This function can be used to send data via an established connection.

Parameters

...

Return

...

Description

Signature

bool xcon.SendText (HTTP POST with XML string) (string, string, number, number, string, string)

This function can be used to send data via an established connection.

Parameters

...

Return

...

Description

Signature

bool xcon.SendTextTo (string, string, string, number)

This function can be used to send data via an established connection.

Parameters

...

Return

...

Description

Signature

xcon.SendUserEmail (string, string, string)

This function can be used to directly send an e-mail to the specified user e-mail address.

Parameters

...

Return

None.

Description

Signature

bool xcon.Upload (string, string, number)

This function initiates an asynchronous FTP upload. If an upload is already taking place on this connection (identified by host, port, user, and password), the transfer is enqueued and commenced once the current transfer is finished. Provide _OnDoneEvent and _OnErrorEvent callback functions to be notified on transfer completion and errors (ref. section 4.6.11).

Parameters

...

Return

...

messenger plugin.