Description, Eventinterval – Echelon OpenLNS User Manual

Page 566

Advertising
background image

OpenLNS Programmer's Reference

529

Syntax

dbPath = object.DatabasePath

Element

Description

dbPath

The full path of the global OpenLNS

database.

object

The

Network

object.

Data Type

String.

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

Description

Summary

Stores description information about the

Network

object

.

Availability

Local, full, lightweight, and independent clients. Note that

some collections are not available to Independent clients.

Syntax

stringValue = object.Description

Element

Description

stringValue

A string description of the

Network

object.

object

The

Network

to be acted on.

Data Type

String.

Read/Write

Read/write.

Added to API

This depends on the object used to access the property.

Generally, this property exists for the objects listed above as

soon as they are added to the API. See the applicable object

to determine what release it was introduced in.

EventInterval

Summary

The interval between event requests.

This property sets the interval at which OpenLNS will call

the GetNextEvent service for your Lightweight Client

application. Each time LNS calls the GetNextEvent service,

your Lightweight Client application will receive a TCP

messag containing all the events it has registered for that

have occurred since the last time the service was called.
Consider a case where this property is set to the default

value of 1 second. OpenLNS will call the GetNextEvent

service every second. The application will receive the events

it has registered for immediately after the service has been

called, or as soon as the events occur after the service has

been called. For example, say LNS calls the GetNextEvent

service, but no events occur for another 750 ms. The

application will receive those events at 750 ms, and will

make the next GetNextEvent request 250 ms later.
If no events occur before the interval defined by the

Advertising