Method signature information. More...

#include <genericserviceclient.hpp>

Classes
class	Argument
	Encapsulates method argument information. More...

class	ReturnValue
	Encapsulates method return value information. More...

Public Member Functions
const Argument &	getArgumentAt (size_t index) const
	Retrieve argument at given position. More...

size_t	getArgumentCount () const
	Return amount of arguments this method requires. More...

int	getArgumentPosition (const string &argumentName) const
	Retrieves the argument position by its name. More...

int	getReturnValueType () const
	Return value type. More...

const string &	getXML () const
	Retrieve the introspected XML. More...

Static Public Member Functions
static MethodSignatureSharedPtr	create (const string &xml)
	Factorize method signature from passed in xml snippet. More...

Detailed Description

Method signature information.

Member Function Documentation

◆ create()

static MethodSignatureSharedPtr kanzi::connect::detail::MethodSignature::create ( const string & xml )

static

Factorize method signature from passed in xml snippet.

Parameters

xml	the method xml definition

Returns: Signature object if passed in xml was valid.

◆ getArgumentAt()

const Argument& kanzi::connect::detail::MethodSignature::getArgumentAt ( size_t index ) const

Retrieve argument at given position.

Parameters

index zero based index, must be 0...getArgumentCount()-1

Returns: argument reference.

◆ getArgumentCount()

size_t kanzi::connect::detail::MethodSignature::getArgumentCount ( ) const

Return amount of arguments this method requires.

Returns: amount of arguments.

◆ getArgumentPosition()

int kanzi::connect::detail::MethodSignature::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

Returns: index of the argument.

◆ getReturnValueType()

int kanzi::connect::detail::MethodSignature::getReturnValueType ( ) const

Return value type.

MessagePackage::ATTRIBUTE_VALUE_TYPE_UNKNOWN if not supported.

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

◆ getXML()

const string& kanzi::connect::detail::MethodSignature::getXML ( ) const

Retrieve the introspected XML.

Returns: XML introspection.

The documentation for this class was generated from the following file:

connect/genericserviceclient.hpp

Classes

Public Member Functions

Static Public Member Functions