doc/src/user/example4.im

   1 .if false
   2 ==================================================================================
   3     Copyright (c) 2020 Nokia
   4     Copyright (c) 2020 AT&T Intellectual Property.
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 .fi
  19
  20 &h2(Alarm Example)
  21 This is an extension of a previous example which sends an alarm
  22 during initialisation and clears the alarm as soon as messages
  23 are being received.
  24 It is unknown if this is the type of alarm that is expected at the
  25 collector, but illustrates how an alarm is allocated, raised and
  26 cleared.
  27
  28
  29 &space
  30 &indent
  31 .** pull in the code from the example directory
  32 &ex_start
  33 .im  j=start-example ../../../examples/xapp_alarm.cpp
  34 &ex_end
  35 &fig( Simple looping sender application with alarm generation. )
  36 &space
  37