User's Manual

276 Module eAPI

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, Nortel 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 45 "Sample message

request" (page 276).

Figure 45

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

— The parameter alarmdescr must start with <alarmdescr> and end

with the </alarmdescr> tag

— The parameter msg must start with <msg> tag and end with the

</msg> tag

— The parameter remove_after must start with <remove_after> tag

and end with the </remove_after> tag

Nortel Communication Server 1000

DECT Messenger Installation and Commissioning — Book 1

NN43120-301 02.01 4 June 2010