IBindingObjectabstract
This interface defines a dynamic binding object. More...
Inheritance diagram for IBindingObject:
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 |
| Gets the Binding Type. More... | |
| virtual tResult | GetServerObject (ucom::ant::iobject_ptr< IObject > &pServerObject) const =0 |
| Gets the Server Object of the BindingObject. More... | |
| virtual tResult | GetBindingProxy (ucom::ant::iobject_ptr< IBindingProxy > &pBindingProxy) const =0 |
| Gets the Binding Proxy of the Dynamic Binding. More... | |
| virtual tResult | Unbind ()=0 |
| Unbind All. 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 char *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... | |
Additional Inherited Members | |
| 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 23 of file interface_binding_object_intf.h.
Member Function Documentation
◆ GetBindingProxy()
|
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()
|
pure virtual |
Gets the Binding Type.
See IBindingType.
- Parameters
-
[out] pBindingType The Binding Type set as return value
- Returns
- Standard Result Code.
◆ GetServerObject()
|
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()
|
pure virtual |
Unbind All.
- Returns
- Standard Result Code.