User's Manual

configuration techniques (through registry, .INI files, database, command line parameters, and
so on) to control the behavior of their applications.
Basic architecture
The architecture of eAPI is embedded in the eKERNEL module. The eAPI interface refers to
the ability of eKERNEL to provide a TCP server, which listens to a specified port, and receives
TCP sockets packages that contain message requests.
Therefore, when building an eAPI-based third-party product, you require an application that
acts as TCP client and establishes a sockets connection to the eKERNEL module, which acts
as TCP server.
Depending on the eKERNEL settings, the sockets connections are kept open or are closed
after reception of a request. When the socket is kept open, the port remains allocated to the
connected client. This is suitable for implementations where a dedicated connection is
required. If multiple clients must address the same eKERNEL port, Avaya recommends that
you close the socket after each ad hoc request. With this approach, a single port can serve to
accept message requests from multiple input sources.
Message format
Message requests to eKERNEL must be formatted according to specific rules. A sample
request is illustrated in Figure 35: Sample message request on page 66.
Figure 35: Sample message request
The following rules apply:
• The string must start with <xml><msgrqs> and end with </msgrs></xml> tags
• At the end of the string, a carriage return (ASCII 13) and line feed (ASCII 10) must be
appended
• The message request must contain 5 parameters
- The parameter set_or_reset must start with <set_or_reset> tag and end with the </
set_or_reset> tag
- The parameter group must start with <group> tag and end with the </group> tag
Module eAPI
66 DECT Messenger Installation and Commissioning — Book 1 March 2012
Comments? [e-mail]