adtf::streaming::IBindingProxy Class Reference

#include <interface_binding_proxy_intf.h>

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

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
virtual tResult	GetServerObject (ucom::ant::iobject_ptr< ucom::ant::IObject > &pBindingServer) const=0
virtual tResult	BindServerObject (const ucom::ant::iobject_ptr< ucom::ant::IObject > &pBindingServer, const ucom::ant::iobject_ptr< const IBindingType > &pBindingType)=0
virtual tResult	UnbindServerObject (const ucom::ant::iobject_ptr< ucom::ant::IObject > &pBindingServer)=0
virtual tResult	AttachRouting (const ucom::ant::iobject_ptr< IBindingProxy > &pBindingTo)=0
virtual tResult	DetachRouting (const ucom::ant::iobject_ptr< IBindingProxy > &pBindingTo)=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")

Protected Member Functions
	~IBindingProxy ()=default
	not destructable
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

This interface defines a dynamic binding object.

Member Function Documentation

AttachRouting()

virtual tResult adtf::streaming::ant::IBindingProxy::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]

pBindingTo

BindingProxy where to root the Server to.

Returns

Standard Result Code.

BindServerObject()

virtual tResult adtf::streaming::ant::IBindingProxy::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]	pBindingServer	Server to bind.
[in]	pBindingType	Type of the server.

Warning

The proxy will return the

Returns

Standard Result Code

Return values

ERR_INVALID_STATE

The Proxy has no server object set (may be not binded to any)

DetachRouting()

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

pure virtual

Detaches a BindingProxy where the routing was set by AttachRouting.

Parameters

[in]

pBindingTo

BindingProxy to detach.

Returns

Standard Result Code.

Return values

ERR_NOT_FOUND

The BindingProxy given by pBindingTo is not attached.

GetBindingType()

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

pure virtual

Gets the binding type of the proxy.

Parameters

[in,out]

pBindingType

binding type of the proxy returned.

Returns

Standard Result Code

Return values

ERR_POINTER

The binding type is not set.

GetServerObject()

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

pure virtual

Gets the ServerObject of the proxy.

Parameters

[in,out]

pBindingServer

object_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_STATE

The Proxy has no server object set (may be not connected)

UnbindServerObject()

virtual tResult adtf::streaming::ant::IBindingProxy::UnbindServerObject ( const ucom::ant::iobject_ptr< ucom::ant::IObject > & pBindingServer )

pure virtual

Unbinds the ServerObject.

Parameters

[in]

pBindingServer

Server to unbind.

Returns

Standard Result Code

---

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

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