example/diameter/launcher/deployments/adml/ACTIONS.md

   1 # ADML actions
   2
   3 ## send_xml_to_entity
   4
   5 Sends a diameter message in xml format (see DTDs/message.dtd) as client to the server(s) configured.
   6
   7 Arguments: xml[, answers_to]
   8 * xml: the diameter message in xml format.
   9 * answers_to: optional step number of a 'wait_xml_from_entity' for a request message.
  10               Steps are the actions numbered from 1 to N
  11 Example(1):
  12 ```
  13 - action: AF/send_xml_to_entity
  14     xml: aar-initial.xml
  15 ```
  16
  17 Example(2):
  18 ```
  19 - action: AF/wait_xml_from_entity
  20   arguments:
  21     xml: dpr.xml
  22
  23 - action: AF/send_xml_to_entity
  24   arguments:
  25     xml: dpa.xml
  26     answers_to: 1
  27 ```
  28
  29 ## wait_xml_from_entity
  30
  31 Waits a diameter message in xml format (see DTDs/message.dtd) as client from the server(s) connected.
  32 Step blocks until match reception (regular expressions could be used).
  33
  34 Arguments: xml
  35 * xml: the diameter message in xml format.
  36
  37 Example:
  38 ```
  39 - action: AFPC/wait_xml_from_entity
  40   arguments:
  41     xml: aaa.xml
  42 ```
  43
  44 ## send_xml_to_client
  45
  46 Sends a diameter message in xml format (see DTDs/message.dtd) as server to any client(s) connected.
  47
  48 Arguments: xml[, answers_to]
  49 * xml: the diameter message in xml format.
  50 * answers_to: optional step number of a 'wait_xml_from_client' for a request message.
  51               Steps are the actions numbered from 1 to N
  52 Example(1):
  53 ```
  54 - action: AF/send_xml_to_client
  55   arguments:
  56     xml: dpr.xml
  57 ```
  58
  59 Example(2):
  60 ```
  61 - action: AFPC/wait_xml_from_client
  62     xml: dpr.xml
  63   arguments:
  64
  65 - action: AFPC/send_xml_to_client
  66     xml: dpa.xml
  67   arguments:
  68 ```
  69
  70 ## wait_xml_from_client
  71
  72 Waits a diameter message in xml format (see DTDs/message.dtd) as server from the client(s) connected.
  73 Step blocks until match reception (regular expressions could be used).
  74
  75 Arguments: xml
  76 * xml: the diameter message in xml format.
  77
  78 Example:
  79 ```
  80 - action: AFPC/wait_xml_from_client
  81   arguments:
  82     xml: dpr.xml
  83 ```
  84