detail::MethodSignature

class kanzi::connect::detail::MethodSignature

Method signature information.

Public Functions

const Argument &getArgumentAt(size_t index) const

Retrieve argument at given position.

Return

argument reference.

Parameters
  • index: zero based index, must be 0…getArgumentCount()-1

size_t getArgumentCount() const

Return amount of arguments this method requires.

Return

amount of arguments.

int getArgumentPosition(const string &argumentName) const

Retrieves the argument position by its name.

-1 if there is no argument with the requested name. argumentName name of the argument

Return

index of the argument.

int getReturnValueType() const

Return value type.

MessagePackage::ATTRIBUTE_VALUE_TYPE_UNKNOWN if not supported.

Return

return value type as one of the MessagePackage::ATTRIBUTE_VALUE_TYPE_* enumerations.

const string &getXML() const

Retrieve the introspected XML.

Return

XML introspection.

Public Static Functions

MethodSignatureSharedPtr create(const string &xml)

Factorize method signature from passed in xml snippet.

Return

Signature object if passed in xml was valid.

Parameters
  • xml: the method xml definition

class Argument

Encapsulates method argument information.

Public Members

string m_name

Name of the argument.

int m_type

Values come from MessagePackage enumerations.

class ReturnValue

Encapsulates method return value information.

Public Members

int m_type

Values come from MessagePackage enumerations.