Changes between Version 1 and Version 2 of documentation/tools/monitoring/rest/daemon

Timestamp:

03/20/12 17:26:15 (12 years ago)

Author:

zagaria

Comment:

--

documentation/tools/monitoring/rest/daemon

@@ -1 +1 @@
 = Daemon interface =
+
+==== interface ====
+
+    Description: This call returns a list of HAMcast interfaces used by this node. The list also contains information about the interfaces, the name, technology, interface id and address.
+
+    URL : /interface
+
+    Arguments : none
+
+    Query :
+{{{
+POST /interface HTTP/1.1
+User-Agent: HAMcast Monitoring
+Content-Length:0
+Content-Type: text/plain; charset=utf-8
+}}}
+
+    Response : 
+     {{{
+HTTP/1.1 200 OK
+Content-Length: 290
+Content-Type: text/xml; charset=utf-8
+
+<?xml version="1.0" encoding="utf-8"?>
+<method>/interface</method>
+<interfaces>
+  <interface>
+    <name>scribe</name>
+    <tech>ALM</tech>
+    <id>1</id>
+    <addr>scribe://21133210321310332313132111321011010120022223330323021211213003330113212213010003</addr>
+  </interface>
+</interfaces>
+}}}
+
+==== neighbor_set ====
+
+    Description: This call returns the neighbor set of an interface, used by this node. 
+
+    URL : /neighbor_set
+
+    Arguments : interface id
+
+    Query :
+{{{
+POST /neighbor_set HTTP/1.1
+User-Agent: HAMcast Monitoring
+Content-Length:8
+Content-Type: text/plain; charset=utf-8
+
+arg0=1
+}}}
+
+    Response : 
+     {{{
+HTTP/1.1 200 OK
+Content-Length: 659
+Content-Type: text/xml; charset=utf-8
+
+<?xml version="1.0" encoding="utf-8"?>
+<method>/neighbor_set</method>
+<neighbors>
+  <neighbor>scribe://02100132231211213233201013231313221131220030310130213030013011330020330122201201</neighbor>
+  <neighbor>scribe://03203203132101101333013122211331301332323000210122301200102012110210221100003222</neighbor>
+  <neighbor>scribe://10203001211130302330230112213311032022101220231003032013300130113310101333233022</neighbor>
+  <neighbor>scribe://31033030302232230032310323033330233110220120033210200301311021131313233211013201</neighbor>
+  <neighbor>scribe://33033131222212112100102012103120103311101121012332002302110221233123233111203321</neighbor>
+</neighbors
+}}}
+
+==== group_set ====
+
+    Description: This call returns a list of HAMcast groups joined by this node.
+
+    URL : /group_set
+
+    Arguments : interface id
+
+    Query :
+{{{
+POST /group_set HTTP/1.1
+User-Agent: HAMcast Monitoring
+Content-Length:8
+Content-Type: text/plain; charset=utf-8
+
+arg0=1
+}}}
+
+    Response : 
+     {{{
+HTTP/1.1 200 OK
+Content-Length: 123
+Content-Type: text/xml; charset=utf-8
+
+<?xml version="1.0" encoding="utf-8"?>
+<method>/group_set</method>
+<groups>
+  <group>ip://239.0.0.2:1234</group>
+</groups>
+}}}
+
+==== parent_set ====
+
+    Description: This call returns the parent set of a group, joined by this node. 
+
+    URL : /parent_set
+
+    Arguments : interface id, HAMcast uri
+
+    Query :
+{{{
+POST /parent_set HTTP/1.1
+User-Agent: HAMcast Monitoring
+Content-Length:34
+Content-Type: text/plain; charset=utf-8
+
+arg0=1
+arg1=ip://239.0.0.2:1234
+}}}
+
+    Response : 
+     {{{
+HTTP/1.1 200 OK
+Content-Length: 198
+Content-Type: text/xml; charset=utf-8
+
+<?xml version="1.0" encoding="utf-8"?>
+<method>/parent_set</method>
+<parents>
+  <parent>scribe://02100132231211213233201013231313221131220030310130213030013011330020330122201201</parent>
+</parents>
+}}}
+
+==== children_set ====
+
+    Description: This call returns the children set of a group, joined by this node. 
+
+    URL : /children_set
+
+    Arguments : interface id, HAMcast uri
+
+    Query :
+{{{
+POST /parent_set HTTP/1.1
+User-Agent: HAMcast Monitoring
+Content-Length:34
+Content-Type: text/plain; charset=utf-8
+
+arg0=1
+arg1=ip://239.0.0.2:1234
+}}}
+
+    Response : 
+     {{{
+HTTP/1.1 200 OK
+Content-Length: 948
+Content-Type: text/xml; charset=utf-8
+
+<?xml version="1.0" encoding="utf-8"?>
+<method>/children_set</method>
+<children>
+  <child>scribe://02100132231211213233201013231313221131220030310130213030013011330020330122201201</child>
+  <child>scribe://03203203132101101333013122211331301332323000210122301200102012110210221100003222</child>
+  <child>scribe://12103323111331011101111002131332230300120210313201001033330203003202312212312212</child>
+  <child>scribe://20122113213310300033212212213103212032131322203103321131210301003033110011203221</child>
+  <child>scribe://23221201123230220321312300222033313330133310300231322021123301023132131300131122</child>
+  <child>scribe://31001132311312033110130111220211220021133010133323303030310133321221122203113311</child>
+  <child>scribe://31033030302232230032310323033330233110220120033210200301311021131313233211013201</child>
+  <child>scribe://33033131222212112100102012103120103311101121012332002302110221233123233111203321</child>
+</children>
+}}}
+
+
+==== is_img ====
+
+    Description: This call returns a flag whether a node is a img or not. This flag can be true or false.
+
+    URL : /is_img
+
+    Arguments : interface id, HAMcast uri
+
+    Query :
+{{{
+POST /is_img HTTP/1.1
+User-Agent: HAMcast Monitoring
+Content-Length:0
+Content-Type: text/plain; charset=utf-8
+}}}
+
+    Response : 
+     {{{
+HTTP/1.1 200 OK
+Content-Length: 83
+Content-Type: text/xml; charset=utf-8
+
+<?xml version="1.0" encoding="utf-8"?>
+<method>/is_img</method>
+<is_img>true</is_img>
+}}}