Updated docs

mspanc · Jun 1, 2016 · 3725bd2 · 3725bd2
1 parent 6dd3959
commit 3725bd2
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -57,6 +57,34 @@ defmodule MyApp.Bus do
   @request_name_message_id :request_name
   @add_match_message_id    :add_match
 
+  @introspection """
+  <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+   "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+  <node name="/com/example/sample_object">
+    <interface name="com.example.SampleInterface">
+      <method name="Frobate">
+        <arg name="foo" type="i" direction="in"/>
+        <arg name="bar" type="s" direction="out"/>
+        <arg name="baz" type="a{us}" direction="out"/>
+        <annotation name="org.freedesktop.DBus.Deprecated" value="true"/>
+      </method>
+      <method name="Bazify">
+        <arg name="bar" type="(iiu)" direction="in"/>
+        <arg name="bar" type="v" direction="out"/>
+      </method>
+      <method name="Mogrify">
+        <arg name="bar" type="(iiav)" direction="in"/>
+      </method>
+      <signal name="Changed">
+        <arg name="new_value" type="b"/>
+      </signal>
+      <property name="Bar" type="y" access="readwrite"/>
+    </interface>
+    <node name="child_of_sample_object"/>
+    <node name="another_child_of_sample_object"/>
+  </node>
+  """
+
   def start_link(hostname, options \\ []) do
     DBux.PeerConnection.start_link(__MODULE__, hostname, options)
   end
@@ -82,6 +110,14 @@ defmodule MyApp.Bus do
     {:backoff, 1000, state}
   end
 
+  def handle_method_call(serial, sender, "/", "Introspect", "org.freedesktop.DBus.Introspectable", _body, _flags, state) do
+    Logger.debug("Got Introspect call")
+
+    {:send, [
+      DBux.Message.build_method_return(serial, sender, [%DBux.Value{type: :string, value: @introspection}])
+    ], state}
+  end
+
   def handle_method_return(_serial, _sender, _reply_serial, _body, @request_name_message_id, state) do
     Logger.info("Name acquired")
     {:noreply, state}
@@ -112,6 +148,7 @@ defmodule MyApp.Bus do
     {:noreply, state}
   end
 end
+
 ```
 
 And of the accompanying process that can control the connection:

diff --git a/lib/peer_connection.ex b/lib/peer_connection.ex
@@ -17,6 +17,34 @@ defmodule DBux.PeerConnection do
         @request_name_message_id :request_name
         @add_match_message_id    :add_match
 
+        @introspection \"\"\"
+        <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+         "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+        <node name="/com/example/sample_object">
+          <interface name="com.example.SampleInterface">
+            <method name="Frobate">
+              <arg name="foo" type="i" direction="in"/>
+              <arg name="bar" type="s" direction="out"/>
+              <arg name="baz" type="a{us}" direction="out"/>
+              <annotation name="org.freedesktop.DBus.Deprecated" value="true"/>
+            </method>
+            <method name="Bazify">
+              <arg name="bar" type="(iiu)" direction="in"/>
+              <arg name="bar" type="v" direction="out"/>
+            </method>
+            <method name="Mogrify">
+              <arg name="bar" type="(iiav)" direction="in"/>
+            </method>
+            <signal name="Changed">
+              <arg name="new_value" type="b"/>
+            </signal>
+            <property name="Bar" type="y" access="readwrite"/>
+          </interface>
+          <node name="child_of_sample_object"/>
+          <node name="another_child_of_sample_object"/>
+        </node>
+        \"\"\"
+
         def start_link(hostname, options \\ []) do
           DBux.PeerConnection.start_link(__MODULE__, hostname, options)
         end
@@ -42,6 +70,14 @@ defmodule DBux.PeerConnection do
           {:backoff, 1000, state}
         end
 
+        def handle_method_call(serial, sender, "/", "Introspect", "org.freedesktop.DBus.Introspectable", _body, _flags, state) do
+          Logger.debug("Got Introspect call")
+
+          {:send, [
+            DBux.Message.build_method_return(serial, sender, [%DBux.Value{type: :string, value: @introspection}])
+          ], state}
+        end
+
         def handle_method_return(_serial, _sender, _reply_serial, _body, @request_name_message_id, state) do
           Logger.info("Name acquired")
           {:noreply, state}
@@ -72,7 +108,6 @@ defmodule DBux.PeerConnection do
           {:noreply, state}
         end
       end
-
   """
 
   require Logger