ADTF  3.13.2
IBindingProxyabstract

This interface defines a dynamic binding object. More...

Inheritance diagram for IBindingProxy:
[legend]

Public Member Functions

 ADTF_IID (IBindingProxy, "bindingproxy.ant.streaming.adtf.iid")
 defintion of interface id
 
virtual tResult GetBindingType (ucom::ant::iobject_ptr< const IBindingType > &pBindingType) const =0
 Gets the binding type of the proxy. More...
 
virtual tResult GetServerObject (ucom::ant::iobject_ptr< ucom::ant::IObject > &pBindingServer) const =0
 Gets the ServerObject of the proxy. More...
 
virtual tResult BindServerObject (const ucom::ant::iobject_ptr< ucom::ant::IObject > &pBindingServer, const ucom::ant::iobject_ptr< const IBindingType > &pBindingType)=0
 Binds the ServerObject the to the proxy. More...
 
virtual tResult UnbindServerObject (const ucom::ant::iobject_ptr< ucom::ant::IObject > &pBindingServer)=0
 Unbinds the ServerObject. More...
 
virtual tResult AttachRouting (const ucom::ant::iobject_ptr< IBindingProxy > &pBindingTo)=0
 Attaches a BindingProxy where to route the ServerObject to. More...
 
virtual tResult DetachRouting (const ucom::ant::iobject_ptr< IBindingProxy > &pBindingTo)=0
 Detaches a BindingProxy where the routing was set by AttachRouting. More...
 
- Public Member Functions inherited from INamedGraphObject
 ADTF_IID (INamedGraphObject, "namedgraphobject.ant.streaming.adtf.iid")
 defintion of interface id
 
virtual tResult GetName (base::ant::IString &&strName) const =0
 Gets the Name of the object to the IString rvalue reference strName. More...
 
virtual tResult SetName (const tChar *strName)=0
 Sets the Name of the object. More...
 
virtual tResult SetParent (const ucom::ant::IObject *oParentObject)=0
 Sets the Parent of the object. More...
 
virtual tResult GetParent (const ucom::ant::IObject *&poParentObject) const =0
 Retrieves the Parent of the object. More...
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Protected Member Functions

 ~IBindingProxy ()=default
 not destructable
 
- Protected Member Functions inherited from INamedGraphObject
 ~INamedGraphObject ()=default
 not destructable
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor –> Use implemented Destroy() instead of delete!
 

Detailed Description

This interface defines a dynamic binding object.

Definition at line 21 of file interface_binding_proxy_intf.h.

Member Function Documentation

◆ AttachRouting()

virtual tResult AttachRouting ( const ucom::ant::iobject_ptr< IBindingProxy > &  pBindingTo)
pure virtual

Attaches a BindingProxy where to route the ServerObject to.

This will automatically resets the Server which is binded to this proxy.

Parameters
[in]pBindingToBindingProxy where to root the Server to.
Returns
Standard Result Code.

◆ BindServerObject()

virtual tResult BindServerObject ( const ucom::ant::iobject_ptr< ucom::ant::IObject > &  pBindingServer,
const ucom::ant::iobject_ptr< const IBindingType > &  pBindingType 
)
pure virtual

Binds the ServerObject the to the proxy.

This interface is used by the IBindingServer instance on IBindingServer::Bind .

Parameters
[in]pBindingServerServer to bind.
[in]pBindingTypeType of the server.
Warning
The proxy will return the
Returns
Standard Result Code
Return values
ERR_INVALID_STATEThe Proxy has no server object set (may be not binded to any)

◆ DetachRouting()

virtual tResult DetachRouting ( const ucom::ant::iobject_ptr< IBindingProxy > &  pBindingTo)
pure virtual

Detaches a BindingProxy where the routing was set by AttachRouting.

Parameters
[in]pBindingToBindingProxy to detach.
Returns
Standard Result Code.
Return values
ERR_NOT_FOUNDThe BindingProxy given by pBindingTo is not attached.

◆ GetBindingType()

virtual tResult GetBindingType ( ucom::ant::iobject_ptr< const IBindingType > &  pBindingType) const
pure virtual

Gets the binding type of the proxy.

Parameters
[in,out]pBindingTypebinding type of the proxy returned.
Returns
Standard Result Code
Return values
ERR_POINTERThe binding type is not set.

◆ GetServerObject()

virtual tResult GetServerObject ( ucom::ant::iobject_ptr< ucom::ant::IObject > &  pBindingServer) const
pure virtual

Gets the ServerObject of the proxy.

Parameters
[in,out]pBindingServerobject_ptr to return the reference of the Server to.
Warning
The proxy will return with no error after the pBindingServer was Reset. If the object_ptr is valid needs still to be checked by the caller.
Returns
Standard Result Code
Return values
ERR_INVALID_STATEThe Proxy has no server object set (may be not connected)

◆ UnbindServerObject()

virtual tResult UnbindServerObject ( const ucom::ant::iobject_ptr< ucom::ant::IObject > &  pBindingServer)
pure virtual

Unbinds the ServerObject.

Parameters
[in]pBindingServerServer to unbind.
Returns
Standard Result Code

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue Nov 16 2021 by doxygen 1.8.14)