beautypg.com

Onincomingsessionevent – Echelon OpenLNS User Manual

Page 737

background image

OpenLNS Programmer's Reference

700

database validation that is

currently being performed. The

phase name will be returned as a

string of up to 230 characters.

thisStepName

The step that is currently being

performed. The step name will be

returned as a string of up to 230

characters. Generally, this will be

the name of the object in the

database that is currently being

validated.

Added to API

LNS Release 3.20.

OnIncomingSessionEvent

Summary

An event that is generated whenever a request for connection

to the OpenLNS Server is received, as long as the application

has registered for uplink session event handling with the

BeginIncomingSessionEvents

method.

After an uplink session request has been received and this

event has been fired, you can use the AcceptIncomingSession

method to accept or reject the request. When you call the

AcceptIncomingSession method, you use the tag element

passed to this event to identify the xDriver session. The other

elements can be used to open the network after the incoming

session is accepted. Do not open the network within the event

handler. Instead, signal your main thread to open the

network by posting a message, or by using a timer.
Once you have accepted a session, you can open the network

identified by the netName element and perform whatever

tasks are required. You can also use the

OnSessionChangeEvent event to monitor the state of the

xDriver session.
You can disable the OnIncomingSessionEvent event with the

EndIncomingSessionEvents method.
These events only apply to clients that are using the

OpenLDV xDriver to connect to remote network interface

(RNI) devices. For an overview of the OpenLDV xDriver, see

the OpenLNS Network Interface Drivers section, of the

OpenLNS Programmer’s Guide.