Beginservicepinevent, Beginsession, Beginsession m – Echelon OpenLNS User Manual

Page 885: S beginservicepinevent, Beginservicepinevent m

Advertising
background image

OpenLNS Programmer's Reference

848

this element is 0–65,535.

Added to API

Prior to LNS Release 3.0.

BeginServicePinEvent

Summary

Enables the

OnSystemServicePin

event for a system

.

An event tag is returned from the method. Multiple service

pin events can be enabled at one time, each having a

different tag. When the service pin event is fired, the event

tag is returned as one of the parameters.

Availability

Local, full, and lightweight clients.

Syntax

eventTag = systemObject.BeginServicePinEvent

Element

Description

systemObject

The System

object to be acted on.

eventTag

An Integer representing an

allocated event tag.

Added to API

Prior to LNS Release 3.0.

BeginSession

Summary

Begins a session for methods and properties that must be

grouped to avoid intermediate error conditions. Currently,

this only applies to operations that affect the physical

topology of a network. All methods invoked and properties

written between the

BeginSession

and

EndSession

methods

are considered atomic

.

This method allows your application to create connections

more efficiently, and avoid failure scenarios that can occur

when devices or routers are moved or changed one-by-one.
This method differs from the StartTransaction method in

that services in a transaction include validation and update

the OpenLNS database as they are invoked, although this

update will not be committed until the transaction is

committed. Sessions allow methods to be invoked and

properties to be written that would individually cause an

error.
For example, consider moving a large number of devices with

subnet broadcast connections and unacknowledged repeat

service from one channel to another. If only some of these

devices are moved, the OpenLNS Object Server would detect

that not all of the devices are on the same subnet and the

move would fail (since unacknowledged repeat service for

domain wide broadcast is not allowed). By grouping the

moves in a session the devices are not actually connected and

Advertising