adtf::streaming::IBindingObject Class Reference

brings latest ant::IBindingObject to users scope More...

#include <interface_binding_object_intf.h>

Inherits adtf::streaming::ant::INamedGraphObject.

Inherited by adtf::streaming::ant::IBindingClient, and adtf::streaming::ant::IBindingServer.

Public Member Functions
	ADTF_IID (IBindingObject, "bindingobject.ant.streaming.adtf.iid")
	definiton of interface id
virtual tResult	GetBindingType (ucom::ant::iobject_ptr< const IBindingType > &pBindingType) const=0
virtual tResult	GetServerObject (ucom::ant::iobject_ptr< IObject > &pServerObject) const=0
virtual tResult	GetBindingProxy (ucom::ant::iobject_ptr< IBindingProxy > &pBindingProxy) const=0
virtual tResult	Unbind ()=0
Public Member Functions inherited from adtf::streaming::ant::INamedGraphObject
	ADTF_IID (INamedGraphObject, "namedgraphobject.ant.streaming.adtf.iid")
	defintion of interface id
virtual tResult	GetName (base::ant::IString &&strName) const =0
virtual tResult	SetName (const char *strName)=0
virtual tResult	SetParent (const ucom::ant::IObject *oParentObject)=0
virtual tResult	GetParent (const ucom::ant::IObject *&poParentObject) const =0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Additional Inherited Members
Protected Member Functions inherited from adtf::streaming::ant::INamedGraphObject
	~INamedGraphObject ()=default
	not destructable
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

brings latest ant::IBindingObject to users scope

This interface defines a dynamic binding object.

Member Function Documentation

GetBindingProxy()

virtual tResult adtf::streaming::ant::IBindingObject::GetBindingProxy ( ucom::ant::iobject_ptr< IBindingProxy > & pBindingProxy ) const

pure virtual

Gets the Binding Proxy of the Dynamic Binding. For a Client Binding Object the Proxy Object is only set if a Server Binding Object was successfully binded (IBindingServer::Bind ). A ucom::IObject::GetInterface call to *ppServerObject must return the interface set by type (see IBindingType::GetInterfaceID )

Parameters

[in,out]

pBindingProxy

Returns the reference to the Binding Proxy if it is set.

Remarks

Use a ucom::ant::iobject_ptr for ppServerObject, it will Refs if function succeeded.

Returns

Standard Result Code.

Return values

ERR_NOERROR	function succeeded.
ERR_POINTER	given ppServerObject is invalid or Server Object is not set yet (not binded yet)

GetBindingType()

virtual tResult adtf::streaming::ant::IBindingObject::GetBindingType ( ucom::ant::iobject_ptr< const IBindingType > & pBindingType ) const

pure virtual

Gets the Binding Type. See IBindingType.

Parameters

[out]

pBindingType

The Binding Type set as return value

Returns

Standard Result Code.

GetServerObject()

virtual tResult adtf::streaming::ant::IBindingObject::GetServerObject ( ucom::ant::iobject_ptr< IObject > & pServerObject ) const

pure virtual

Gets the Server Object of the BindingObject. For a Client Binding Object the Server Object is only set if a Binding Proxy was successfully binded (IBindingClient::Bind ).

Parameters

[in]

pServerObject

Returns the reference to the Server Object if it is set.

Returns

Standard Result Code.

Return values

ERR_NOERROR	function succeeded.
ERR_POINTER	given pServerObject is invalid or Server Object is not set yet (not binded yet)

Unbind()

virtual tResult adtf::streaming::ant::IBindingObject::Unbind ( )

pure virtual

Unbind All

Returns

Standard Result Code.

---

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

• src/libraries/streaming3/include/adtfstreaming3/interface_binding_object_intf.h