class DBus::Method

D-Bus interface method class¶ ↑

This is a class representing methods that are part of an interface.

Attributes

@return [Array<FormalParameter>] The list of return values for the method

Public Class Methods

Source

# File lib/dbus/introspect.rb, line 185
def initialize(name)
  super(name)
  @rets = []
end

Creates a new method interface element with the given name.

Calls superclass method DBus::InterfaceElement::new

Public Instance Methods

add_return (name, signature)

Source

# File lib/dbus/introspect.rb, line 193
def add_return(name, signature)
  @rets << FormalParameter.new(name, signature)
end

Add a return value name and signature. @param name [#to_s] @param signature [SingleCompleteType]

from_prototype (prototype)

Source

# File lib/dbus/introspect.rb, line 199
def from_prototype(prototype)
  prototype.split(/, */).each do |arg|
    arg = arg.split(" ")
    raise InvalidClassDefinition if arg.size != 2

    dir, arg = arg
    if arg =~ /:/
      arg = arg.split(":")
      name, sig = arg
    else
      sig = arg
    end
    case dir
    when "in"
      add_fparam(name, sig)
    when "out"
      add_return(name, sig)
    end
  end
  self
end

Add parameter types by parsing the given prototype. @param prototype [Prototype]

to_xml ()

Source

# File lib/dbus/introspect.rb, line 223
def to_xml
  xml = "    <method name=\"#{@name}\">\n"
  @params.each do |param|
    name = param.name ? "name=\"#{param.name}\" " : ""
    xml += "      <arg #{name}direction=\"in\" type=\"#{param.type}\"/>\n"
  end
  @rets.each do |param|
    name = param.name ? "name=\"#{param.name}\" " : ""
    xml += "      <arg #{name}direction=\"out\" type=\"#{param.type}\"/>\n"
  end
  xml += "    </method>\n"
  xml
end

Return an XML string representation of the method interface elment. @return [String]