CProxy Class Reference

A proxy is a local handle to a remote object. More...

#include <charm++.h>

Inheritance diagram for CProxy:

Collaboration diagram for CProxy:


Public Member Functions
	CProxy (const CProxy &src)
	Copy constructor. Only needed for delegated proxies.
CProxy &	operator= (const CProxy &src)
	Assignment operator. Only needed for delegated proxies.
	~CProxy ()
	Destructor. Only needed for delegated proxies.
void	ckDelegate (CkDelegateMgr to, CkDelegateData pd=NULL)
	Delegation allows a class, called a CkDelegateMgr, to intercept calls made to this proxy for further processing.
void	ckUndelegate (void)
	Remove delegation from this proxy.
int	ckIsDelegated (void) const
	Return true if this proxy is delegated.
CkDelegateMgr *	ckDelegatedTo (void) const
	Return the delegator of this proxy, to which the proxies' messages are actually sent.
CkDelegateData *	ckDelegatedPtr (void) const
	Return the delegator's local data associated with this proxy.
CkGroupID	ckDelegatedIdx (void) const
	Return the groupID of our delegator.
void	pup (PUP::er &p)
	Pup the data for this proxy. Only needed for delegated proxies.
Protected Member Functions
	CProxy ()
	CProxy (CK_DELCTOR_PARAM)
	Delegation constructor: used when building an element proxy from a collective proxy, like in "aProxy[i]".
Private Attributes
CkGroupID	delegatedGroupId
int	isNodeGroup
CkDelegateMgr *	delegatedMgr
CkDelegateData *	delegatedPtr

Detailed Description

A proxy is a local handle to a remote object.

This is the superclass of all proxies: CProxy_Array, CProxy_Group, etc. inherit from this class.

Real proxies for user classes are generated by the .ci file translator charmxi and put in the generated .decl.h headers.

Definition at line 567 of file charm++.h.

Constructor & Destructor Documentation

CProxy::CProxy ( ) [inline, protected]

Definition at line 574 of file charm++.h.

References delegatedGroupId, and _ckGroupID::setZero().

CProxy::CProxy ( CK_DELCTOR_PARAM ) [inline, protected]

Delegation constructor: used when building an element proxy from a collective proxy, like in "aProxy[i]".

Definition at line 582 of file charm++.h.

References CkDelegateMgr::ckCopyDelegateData(), IrrGroup::CkGetGroupID(), delegatedGroupId, delegatedMgr, delegatedPtr, IrrGroup::isNodeGroup(), and isNodeGroup.

CProxy::CProxy ( const CProxy & src )

Copy constructor. Only needed for delegated proxies.

Copy constructor.

Definition at line 309 of file ck.C.

References CkDelegateMgr::ckCopyDelegateData(), delegatedMgr, and delegatedPtr.

CProxy::~CProxy ( ) [inline]

Destructor. Only needed for delegated proxies.

Definition at line 598 of file charm++.h.

References delegatedPtr, and CkDelegateData::unref().

Member Function Documentation

CProxy & CProxy::operator= ( const CProxy & src )

Assignment operator. Only needed for delegated proxies.

Assignment operator.

Definition at line 319 of file ck.C.

References CkDelegateMgr::ckCopyDelegateData(), ckUndelegate(), delegatedGroupId, delegatedMgr, delegatedPtr, isNodeGroup, and CkDelegateData::unref().

Referenced by PUPmarshall().

void CProxy::ckDelegate	(	CkDelegateMgr *	dTo,
		CkDelegateData *	dPtr = `NULL`
	)

Delegation allows a class, called a CkDelegateMgr, to intercept calls made to this proxy for further processing.

FIXME: make a "CkReferenceHandle<CkDelegateData>" class to avoid this tricky manual reference counting business.

"ptr" is any delegator-specific data the CkDelegateMgr wants to associate with this proxy: the pointer is owned by this proxy, but will be copied and pupped by calling delegator routines.

This interface should only be used by library writers, not ordinary user code.

..

Definition at line 293 of file ck.C.

References IrrGroup::CkGetGroupID(), ckUndelegate(), delegatedGroupId, delegatedMgr, delegatedPtr, IrrGroup::isNodeGroup(), isNodeGroup, and CkDelegateData::ref().

Referenced by ComlibAssociateProxy().

void CProxy::ckUndelegate ( void )

Remove delegation from this proxy.

Definition at line 301 of file ck.C.

References delegatedGroupId, delegatedMgr, delegatedPtr, _ckGroupID::setZero(), and CkDelegateData::unref().

Referenced by ckDelegate(), and operator=().

int CProxy::ckIsDelegated ( void ) const [inline]

Return true if this proxy is delegated.