Echelon OpenLDV User Manual Page 172
- Page / 194
- Table of contents
- BOOKMARKS
Rated. / 5. Based on customer reviews
164 Custom Lookup Extension Component Programming
ILdvxLookup Interface
The lookup interface is the primary interface implemented by an xDriver lookup
extension component. It defines the methods that are used to look up session
parameters in your xDriver database.
DownlinkLookup Method
Applies to: xDriver Lookup Extension Component
This method is called by xDriver when a downlink session is initiated. It is
passed a pointer to the xDriver Session Control Object (SCO) for the session. The
SCO contains the downlink lookup key to be looked up. This lookup key comes
from the network interface name of the RNI being opened. For example, in the
"X.Custom.Location-123" NetworkInterface name, the downlink key is "Location-
123".
It is the responsibility of the xDriver lookup extension to extract the downlink
lookup key from the SCO, use it to access its xDriver database, and retrieve the
authentication and TCP parameters to be used by the rest of the xDriver
framework. Then, the lookup extension component must fill in the corresponding
fields of the SCO, including the Authentication Flag, Current Authentication
Key, Next Authentication Key, Additional Downlink Packet Header (optional),
Additional Downlink Packet Trailer (optional), Encryption Type, Remote TCP
Address, and Remote TCP Port. This information is used by xDriver to complete
the session establishment.
The ILdvxSCO interface provides methods that you can use to obtain the
downlink lookup key and fill in the SCO fields. For more information, see
ILdvxSCO Interface on page 166.
Syntax
C++ STDMETHOD(DownlinkLookup)(ILdvxSCO * xSCO)
Visual Basic Sub DownlinkLookup(ByVal xSCO As LdvxLib.ILdvxSCO)
Table 45. DownlinkLookup Parameters
Parameter Description
xSCO Pointer to the SCO object that contains the downlink key to be looked
up. The DownlinkLookup implementation should fill the required
fields into the SCO.
Returns
Standard xDriver LdvxResult (HRESULT) describing the result of the call. The
result is typically LDVX_S_OK (see LdvxResult). If the specified downlink key
is not recognized, the lookup extension component must return the error code
- OpenLDV 1
- Programmer’s Guide 1
- Welcome 3
- Audience 3
- Examples 4
- Related Documentation 4
- Table of Contents 5
- Introduction 9
- ONWORKS network: 10
- OpenLDV Driver 11
- Client Applications 11
- Network Interfaces 12
- Installing the OpenLDV SDK 14
- Using the OpenLDV API 17
- ONWORKS network 18
- Application Layer 20
- Presentation Layer 21
- Overview of the OpenLDV API 21
- The OpenLDV API 23
- ONWORKS interface device 24
- ONWORKS name (such as 24
- LDVDevices Structure 46
- LdvCombineFlags Enumeration 47
- LdvDeviceCaps Enumeration 48
- LDVDriverInfo Structure 50
- LdvDriverID Enumeration 51
- LdvDriverType Enumeration 52
- OpenLDV API Return Codes 53
- ONWORKS Interfaces 57
- msgSize); 62
- Constructing Messages 66
- Application Buffer Structure 66
- Layer 2 Buffer Structure 69
- Application Layer Header 69
- Layer 2 Header 69
- Layer 5 Buffer Structure 70
- Message Header 70
- ExpMsgHdr 71
- NetVarHdr 73
- ONWORKS transceivers 74
- Network Address 75
- RcvAddrDtl 78
- RespAddrDtl 80
- Message Data 81
- UnprocessedNV 82
- ExplicitMsg 82
- Downlink Commands 84
- Uplink Commands 85
- Immediate Commands 85
- Network Interface Commands 85
- Common Definitions 98
- Dispatchers 98
- Toolkits and User Interface 99
- Developer Example Diagram 100
- ONWORKS 101
- LNS Applications for xDriver 106
- Extending xDriver 107
- Downlink Sessions 108
- 102 Extending xDriver 110
- Typical Downlink Scenario 111
- Uplink Sessions 112
- ONWORKS network, in a 114
- Typical Uplink Scenario 115
- Session Control Object 116
- Authentication Key Handling 119
- ONWORKS \xDriver\Components 123
- Add a COM Object 124
- Test the Lookup Extension 132
- Optional Steps 132
- Add a COM Class 135
- LNS Programming with xDriver 145
- ONWORKS networks 147
- ONWORKS networks by 148
- Uplink Sample Application 150
- Custom Network Interfaces 155
- Overview 156
- Windows Registry Entries 158
- LNS Methods and Events for 161
- AcceptIncomingSession 162
- Remarks 162
- BeginIncomingSessionEvents 163
- EndIncomingSessionEvents 163
- NetworkInterfaces.Item( ) 164
- Syntax 164
- OnIncomingSessionEvent 165
- ReleasePendingUpdates 166
- Custom Lookup Extension 169
- Component Programming 169
- ILdvxConfigure Interface 170
- SetInstance Method 170
- Returns 171
- SetOptions Method 171
- ILdvxLookup Interface 172
- DownlinkLookup Method 172
- UpdateLookup Method 173
- UplinkLookup Method 173
- ILdvxSCO Interface 174
- GetDownlinkKey Method 177
- GetUplinkKey Method 180
- SetAuthenticationFlag Method 181
- SetDownlinkKey Method 183
- SetEncryptionType Method 183
- SetLNSNetworkName Method 184
- SetUplinkKey Method 186
- ILdvxSCO_TCP Interface 186
- GetRemoteTCPAddress Method 187
- GetRemoteTCPPort Method 187
- SetRemoteTCPAddress Method 188
- SetRemoteTCPPort Method 188
- ILdvxSCO2 Interface 189
- GetNeuronID Method 189
- 184 Index 192
Related products and manuals for Software Echelon OpenLDV
Software Echelon LNS Plug-in User Manual
(69 pages)
(69 pages)
Software Echelon LonBridg Server User Manual
(67 pages)
(67 pages)
Software Echelon FT 5000 EVB User Manual
(36 pages)
(36 pages)
Software Echelon Mini FX User Manual
(139 pages)
(139 pages)
Software Echelon NodeBuilder FX User Manual
(300 pages)
(300 pages)
Software Echelon LonMaker User Manual
(423 pages)
(423 pages)
Software Echelon Mini EVK User Manual
(98 pages)
(98 pages)
Software Echelon Mini EVK FT User Manual
(2 pages)
(2 pages)
Software Echelon LNS User Manual
(368 pages)
(368 pages)
Software Echelon LonMaker User Manual
(318 pages)
(318 pages)
Software Echelon LNS DDE Server User Manual
(160 pages)
(160 pages)
© 2020, manymanuals.com. All rights reserved. | 0.381 s |
Manymanuals.com
Manymanuals.de
Manymanuals.fr
Manymanuals.it
Manymanuals.pl
Manymanuals.cz
Manymanuals.es
Manymanuals-pt.com
Comments to this Manuals