Agg_start()

Top  Previous  Next

Description:

API procedure, starts the AGG library, parses the configuration file, prepares the library for operation.

Syntax:

function agg_start(interface as pl_sock_interfaces, byref owner_name as string, byref device_name as string, byref password as string, byref agg_server_ip as string, agg_server_port as word, agg_server_tout as word, auto_reg as no_yes) as en_agg_status_codes

Returns:

One of the en_agg_status_codes

See Also:

The Embryo

 

Part

Description

interface

The network interface through which the library will be connecting to the AggreGate server. The list of available interfaces is platform-dependent (look for the Enum pl_sock_interfaces topic inside your platform's documentation).

owner_name

Must match your account on the AggreGate server ("admin" by default).

device_name

The name under which the device will appear in the list of devices under your account.

password

The password your device will use to login to the AggreGate server.

agg_server_ip

The IP address of the AggreGate server.

agg_server_port

The listening port on the AggreGate server (6480 by default).

agg_server_tout

Maximum waiting time for the AggreGate server interactions. The recommended value is 600.

auto_reg

Whether or not the device will be allowed to register on the AggreGate server if the server does not already have this device under the specified owner_name account

Details

MUST be called first, before any other procedure in this library is invoked, or EN_AGG_STATUS_NOT_STARTED will be returned by every other procedure you call.