HAMcast developers

Version 13 (modified by zagaria, 13 years ago) (diff)

--

Collector interface

std::string function_wrapper::group_list(std::vector<std::string> args)

Description: This call returns a list of HAMcast groups. The groups in this list are a merged set of groups gathered from all reachable HAMcast nodes.

URL : /group_list

Arguments : none

XML :

<method>
 /group_list
<\method>
<groups>
 <group>
  group1
 <\group>
 <group>
   group2
 <\group>
<\groups>

std::string function_wrapper::node_list(std::vector<std::string> args)

Description: Returns a list of daemon-id. The list contains the daemon-ids of all reachable HAMcast nodes.

URL : /node_list

Arguments : none

XML :

<method>
 /node_list
<\method>
<nodes>
 <node>
  daemon-id
 <node>
 <node>
  daemon-id
 <node>
<\nodes>

std::string function_wrapper::group_data(std::vector<std::string> args)

Description: Returns a list of daemon-id. The list contains the daemon-ids of all reachable HAMcast nodes that joined the given group.

URL : /group_data

Arguments : HAMcast group uri

XML :

<method>
 /group_data
</method>
<group>
 <name>
  group name
 </name>
 <member>
  daemon-id
 </member>
 <member>
  daemon-id
 </member>
</group>

std::string function_wrapper::node_data(std::vector<std::string> args)

Description: Returns detailed interface and group information about a node, interface and groups.

Node: daemon-id, img-flag Interface: interfcae-id, technology, interface-name, interface-address Groups: group-name, parent, parent, children

URL : /node_data

Arguments : daemon-id

XML :

<name>
 daemon-id
</name>
<interfaces>
 <interface>
  <name>
   IPv4
  <name>
  <technology>
   native
  </technology>
  <id>
   1
  </id>
  <address>
   ip-address
  </address>
  <groups>
   <group>
    <name>
     group1
    </name>
    <parent>
     address
    </parent>
    <children>
     <child>
      address
     </child>
     <child>
      address
     </child>
    </children>
   </group>
  </groups>
 <interface>
</interfaces>

std::string function_wrapper::group_tree(std::vector<std::string> args)

Description: Returns a list of edges between nodes for a given group. The edges are directed from source to destination.

URL : /group_tree

Arguments : HAMcast group uri

XML :

<method>
 /group_tree
</method>
<edges>
 <edge>
  <from>
   daemon-id
  </from>
  <to>
   daemon-id
  </to>
 </edge>
 <edge>
  <from>
   daemon-id
  </from>
  <to>
   daemon-id
  </to>
 </edge>
</edges>