osg::RemoteAspect Class Reference
[Cluster]

Remote aspect controll class. More...

#include <OSGRemoteAspect.h>

List of all members.

Remote aspect functionaliy
typedef std::map< UInt32, UInt32 >	clStoreMap
typedef clStoreMap::iterator	clStoreIt
void	receiveSync (Connection &connection, bool applyToChangelist=false)
void	sendSync (Connection &connection, ChangeList *changeList=NULL)
void	registerCreated (const FieldContainerType &type, const Functor &func)
void	registerDestroyed (const FieldContainerType &type, const Functor &func)
void	registerChanged (const FieldContainerType &type, const Functor &func)
static void	addFieldFilter (UInt32 typeId, BitVector mask)
static void	subFieldFilter (UInt32 typeId, BitVector mask)
static void	restoreChangeList (ChangeList *tocl)
static void	storeChangeList (ChangeList *cl)
static UInt32	getStoreSize (void)
static clStoreMap &	getStore (void)
static void	createCurrentStateChangeList (const FieldContainerPtr &start, ChangeList *cl)
member
UInt32	_aspectId
LocalFCMapT	_localFC
RemoteFCMapT	_remoteFC
LocalTypeMapT	_localType
IdSetT	_sentFC
IdSetT	_receivedFC
IdSetT	_mappedFC
IdSetT	_mappedType
UInt32	_remoteAspectId
std::vector< Functor >	_createdFunctors
std::vector< Functor >	_destroyedFunctors
std::vector< Functor >	_changedFunctors
StatCollector *	_statistics
static FieldFilterT	_fieldFilter
static std::map< UInt32, UInt32 >	_clStore
static elements
static StatElemDesc< StatTimeElem >	statSyncTime
static bool	_defaultCreatedFunction (FieldContainerPtr &fcp, RemoteAspect *aspect)
static bool	_defaultDestroyedFunction (FieldContainerPtr &fcp, RemoteAspect *aspect)
static bool	_defaultChangedFunction (FieldContainerPtr &fcp, RemoteAspect *aspect)
Public Types
enum	DataTypes {   SYNCENDED = 1, CREATED = 2, DESTROYED = 3, NEWTYPE = 4,   CHANGED = 5, ADDREFED = 6, SUBREFED = 7, IDMAPPING = 8 }
typedef ArgsCollector < RemoteAspect * >	FunctorArgs
typedef TypedFunctor2Base < bool, CPtrRefCallArg < FieldContainerPtr > , FunctorArgs >	Functor
typedef std::map< UInt64, UInt32 >	LocalFCMapT
typedef std::map< UInt32, UInt64 >	RemoteFCMapT
typedef std::map< UInt32, UInt32 >	LocalTypeMapT
typedef std::set< UInt32 >	IdSetT
typedef std::map< UInt32, BitVector >	FieldFilterT
typedef std::map< UInt32, BitVector >	FieldMaskMapT
Public Member Functions
Constructors
	RemoteAspect (UInt32 aspectId=0)
virtual	~RemoteAspect (void)
Statistics
void	setStatistics (StatCollector *stat)
Protected Member Functions
protected helper functions
bool	callCreated (FieldContainerPtr &node)
bool	callDestroyed (FieldContainerPtr &node)
bool	callChanged (FieldContainerPtr &node)
Private Member Functions
	RemoteAspect (const RemoteAspect &source)
RemoteAspect &	operator= (const RemoteAspect &source)
Helper functions
void	handleFCMapping (Connection &connection)
void	clearFCMapping (UInt32 localId, UInt32 remoteId)
bool	getLocalId (UInt32 remoteId, UInt32 &localId)
UInt64	getFullRemoteId (UInt32 remoteId)
Friends
class	RemoteAspectFieldContainerMapper

---

Detailed Description

The RemoteAspecet is used to synchronize changes of FieldContainers with remote hosts. All changes stored in the current change list are send to a Connection.

It is possible to send changes in both directions.

Definition at line 60 of file OSGRemoteAspect.h.

---

Member Typedef Documentation

typedef ArgsCollector<RemoteAspect *> osg::RemoteAspect::FunctorArgs

functor called for changed containers

Definition at line 78 of file OSGRemoteAspect.h.

typedef TypedFunctor2Base<bool, CPtrRefCallArg<FieldContainerPtr>, FunctorArgs > osg::RemoteAspect::Functor

Definition at line 81 of file OSGRemoteAspect.h.

typedef std::map<UInt64,UInt32> osg::RemoteAspect::LocalFCMapT

Map remote to local id

Definition at line 84 of file OSGRemoteAspect.h.

typedef std::map<UInt32,UInt64> osg::RemoteAspect::RemoteFCMapT

Map local to remote id

Definition at line 86 of file OSGRemoteAspect.h.

typedef std::map<UInt32,UInt32> osg::RemoteAspect::LocalTypeMapT

Map remote to local type

Definition at line 88 of file OSGRemoteAspect.h.

typedef std::set<UInt32> osg::RemoteAspect::IdSetT

id set

Definition at line 91 of file OSGRemoteAspect.h.

typedef std::map<UInt32,BitVector> osg::RemoteAspect::FieldFilterT

Field filter map

Definition at line 94 of file OSGRemoteAspect.h.

typedef std::map<UInt32,BitVector> osg::RemoteAspect::FieldMaskMapT

Definition at line 95 of file OSGRemoteAspect.h.

typedef std::map<UInt32, UInt32> osg::RemoteAspect::clStoreMap

Definition at line 126 of file OSGRemoteAspect.h.

typedef clStoreMap::iterator osg::RemoteAspect::clStoreIt

Definition at line 127 of file OSGRemoteAspect.h.

---

Member Enumeration Documentation

enum osg::RemoteAspect::DataTypes

Message types

Enumerator:

SYNCENDED
CREATED
DESTROYED
NEWTYPE
CHANGED
ADDREFED
SUBREFED
IDMAPPING

Definition at line 65 of file OSGRemoteAspect.h.

    {
        SYNCENDED =1,
        CREATED   =2,
        DESTROYED =3,
        NEWTYPE   =4,
        CHANGED   =5,
        ADDREFED  =6,
        SUBREFED  =7,
        IDMAPPING =8
    };

---

Constructor & Destructor Documentation

RemoteAspect::RemoteAspect

(

UInt32

aspectId = 0

)

Constructor

Definition at line 84 of file OSGRemoteAspect.cpp.

References _fieldFilter, osg::FieldContainerFactory::endTypes(), osg::WindowBase::getClassType(), osg::FragmentProgramChunkBase::getClassType(), osg::VertexProgramChunkBase::getClassType(), osg::CubeTextureChunkBase::getClassType(), osg::TextureChunkBase::getClassType(), osg::SurfaceBase::getClassType(), osg::GeometryBase::getClassType(), osg::TypeBase::getId(), osg::ProgramChunkBase::GLIdFieldMask, osg::TextureChunkBase::GLIdFieldMask, osg::GeometryBase::GLIdFieldMask, osg::WindowBase::GlObjectEventCounterFieldMask, osg::WindowBase::GlObjectLastRefreshFieldMask, osg::WindowBase::GlObjectLastReinitializeFieldMask, osg::SurfaceBase::SurfaceGLIdFieldMask, and osg::FieldContainerFactory::the().

                                          :
    _aspectId(aspectId),

    _localFC(),
    _remoteFC(),
    _localType(),

    _sentFC(),
    _receivedFC(),
    _mappedFC(),
    _mappedType(),

    _createdFunctors(),
    _destroyedFunctors(),
    _changedFunctors(),
    _statistics(NULL)
{
    FieldContainerFactory::TypeMapIterator  typeI;

    // initialize field filter
    _fieldFilter[Geometry::getClassType().getId()] = 
        Geometry::GLIdFieldMask;
    _fieldFilter[Surface::getClassType().getId()] = 
        Surface::GLIdFieldMask | Surface::SurfaceGLIdFieldMask;
    _fieldFilter[TextureChunk::getClassType().getId()] = 
        TextureChunk::GLIdFieldMask;
    _fieldFilter[CubeTextureChunk::getClassType().getId()] = 
        CubeTextureChunk::GLIdFieldMask;
    _fieldFilter[VertexProgramChunk::getClassType().getId()] = 
        VertexProgramChunk::GLIdFieldMask;
    _fieldFilter[FragmentProgramChunk::getClassType().getId()] = 
        FragmentProgramChunk::GLIdFieldMask;

    for(typeI = FieldContainerFactory::the()->beginTypes();
            typeI != FieldContainerFactory::the()->endTypes(); ++typeI)
    {
        if(typeI->second->isDerivedFrom(Window::getClassType()))
        {
            _fieldFilter[typeI->second->getId()
                    ] = Window::GlObjectEventCounterFieldMask |
                Window::GlObjectLastRefreshFieldMask |
                Window::GlObjectLastReinitializeFieldMask;
        }
    }
}

RemoteAspect::~RemoteAspect

(

void

)

[virtual]

Destructor

Definition at line 132 of file OSGRemoteAspect.cpp.

References _receivedFC, callDestroyed(), osg::AttachmentContainerPtr::dcast(), osg::NodePtr::dcast(), osg::FieldContainerFactory::getContainer(), osg::NullFC, osg::subRefCP(), and osg::FieldContainerFactory::the().

{
    FieldContainerFactory   *factory = FieldContainerFactory::the();
    IdSetT::iterator        i;
    FieldContainerPtr       fcPtr;
    NodePtr                 node;
    WindowPtr               window;

    // subRef received field container
    for(i = _receivedFC.begin(); i != _receivedFC.end(); i++)
    {
        fcPtr = factory->getContainer(*i);
        if(fcPtr != NullFC)
        {
            callDestroyed(fcPtr);

            // currently it is not save to subref all
            // containers because we don't know whether
            // they are referenced by other nodes.
            // It's only save to remove nodes without parents
            node = NodePtr::dcast(fcPtr);
            if(node != NullFC)
            {
                if(node->getParent() == NullFC)
                {
                    do
                    {
                        subRefCP(fcPtr);
                        fcPtr = factory->getContainer(*i);
                    } while(fcPtr != NullFC);
                }
            }
            window = WindowPtr::dcast(fcPtr);
            if(window != NullFC)
            {
                do
                {
                    subRefCP(fcPtr);
                    fcPtr = factory->getContainer(*i);
                } while(fcPtr != NullFC);
            }
            /*
            // subref twice because we have two addrefs on reate
            // It is not possible to subref until the node is removed
            // because if this node is referenced by another node
            // then we will have a crash if we try to subref this
            // other node.
            subRefCP(fcPtr);
            subRefCP(fcPtr);
            */
        }
    }
}

osg::RemoteAspect::RemoteAspect

(

const RemoteAspect &

source

)

[private]

---

Member Function Documentation

void RemoteAspect::receiveSync	(	Connection &	connection,
		bool	applyToChangelist = false
	)

receiveSync reads changes from the given connection and applies them to the current thread aspect. Functors for registered types are called, if they occure in the sync stream.

See also:

registerCreated registerChanged registerDeleted

Definition at line 196 of file OSGRemoteAspect.cpp.

References _aspectId, _localFC, _localType, _receivedFC, osg::RemoteAspectFieldContainerMapper::_remoteAspect, _remoteAspectId, _remoteFC, _statistics, osg::addRefCP(), ADDREFED, osg::beginEditCP(), callChanged(), callCreated(), callDestroyed(), CHANGED, osg::changedCP(), clearFCMapping(), CREATED, osg::FieldContainerType::createFieldContainer(), DESTROYED, osg::endEditCP(), FDEBUG, osg::FieldContainerFactory::findType(), osg::BinaryDataHandler::get(), osg::Field::getCardinality(), osg::TypeBase::getCName(), osg::FieldContainerFactory::getContainer(), osg::StatCollector::getElem(), osg::FieldContainerPtrBase::getFieldContainerId(), getFullRemoteId(), getLocalId(), osg::FieldDescription::getName(), osg::FieldContainerType::getNumFieldDescs(), osg::Field::getType(), osg::BinaryDataHandler::getValue(), IDMAPPING, NEWTYPE, osg::NullFC, osg::Connection::selectChannel(), osg::FieldContainerFactory::setMapper(), SFATAL, osg::FieldType::SINGLE_FIELD, statSyncTime, osg::IDString::str(), osg::subRefCP(), SUBREFED, SWARNING, SYNCENDED, and osg::FieldContainerFactory::the().

Referenced by osg::ClusterServer::doSync().

{
    bool                                finish = false;
    UInt8                               cmd;
    UInt32                              remoteTypeId;
    UInt32                              localTypeId;
    UInt32                              remoteId;
    UInt32                              localId;
    UInt32                              localAspect;
    std::string                         name;
    FieldContainerFactory               *factory = FieldContainerFactory::the();
    FieldContainerType                  *fcType;
    FieldContainerPtr                   fcPtr;
    BitVector                           mask;
    RemoteAspectFieldContainerMapper    mapper;
    UInt64                              fullRemoteId;
    LocalTypeMapT::iterator             localTypeI;
    LocalFCMapT::iterator               localFCI;
    UInt32                              len;

    // hack. No materialchange after image chagne
    std::vector<std::pair<FieldContainerPtr,BitVector> > changedFCs;

    if(_statistics)
    {
        _statistics->getElem(statSyncTime)->start();
    }

    connection.selectChannel();
    connection.getValue(_remoteAspectId);

    // register mapper into factory
    mapper._remoteAspect = this;
    factory->setMapper(&mapper);
    do
    {
        connection.getValue(cmd);
        switch(cmd)
        {
        case NEWTYPE:
            {
                connection.getValue(remoteTypeId);
                connection.getValue(name);

                // find local type
                fcType = FieldContainerFactory::the()->findType(name.c_str());
                if(!fcType)
                {
                    SWARNING << "Unknown Type: " << name << std::endl;
                }
                else
                {
                    localTypeId = FieldContainerFactory::the()->findType(name.c_str())->getId();

                    // insert remote type id into map
                    _localType[remoteTypeId] = localTypeId;
                }
                break;
            }

        case CREATED:
            {
                connection.getValue(remoteTypeId);
                connection.getValue(remoteId);
                localTypeI = _localType.find(remoteTypeId);
                if(localTypeI == _localType.end())
                {
                    SWARNING <<
                        "Unknown TypeID: " <<
                        remoteTypeId <<
                        " for remote id " <<
                        remoteId <<
                        std::endl;
                }
                else
                {
                    UInt64 fullRemoteId=getFullRemoteId(remoteId);
                    if(_localFC.find(fullRemoteId) == _localFC.end())
                    {
                        localTypeId = localTypeI->second;
                        fcType = factory->findType(localTypeId);
                        fcPtr = fcType->createFieldContainer();
                        
                        // remove this node, when aspect is removed
                        _receivedFC.insert(fcPtr.getFieldContainerId());
                        
                        // local <-> remote mapping
                        _localFC[fullRemoteId] = fcPtr.getFieldContainerId();
                        _remoteFC[fcPtr.getFieldContainerId()] = fullRemoteId;
                        
                        // make shure, client will not subref to zero
                        addRefCP(fcPtr);
                        addRefCP(fcPtr);
                        callCreated(fcPtr);
                    }
                    else
                    {
                        FDEBUG(("FC already created %d\n",remoteId));
                    }
                }
                break;
            }

        case DESTROYED:
            {
                connection.getValue(remoteId);
                if(getLocalId(remoteId,localId))
                {
                    clearFCMapping(localId,remoteId);
                    fcPtr = factory->getContainer(localId);
                    if(fcPtr != NullFC)
                    {
                        callDestroyed(fcPtr);

                        // remove all references to avoid multiple
                        // removes.
                        // The changelist does not contain changes
                        // if the container was removed in this frame.
                        // So when a pointerfield is set to NullFC
                        // the new value is not transfered to the
                        // server.
                        FieldContainerType &fcType = fcPtr->getType();
                        for(UInt32 i = 1; i <= fcType.getNumFieldDescs(); ++i)
                        {
                            FieldDescription *desc = fcPtr->getType().getFieldDescription(i);
                            // ignore beacon fields. I don't know any clean
                            // solution. In CamearDecorator the acces method
                            // to beacon is overloaded. As a result, if the
                            // beacon field in the decorator is modified,
                            // the decorated camera is modified. In most
                            // cases this is OK, but not in this case.
                            if(strcmp(desc->getName().str(),"beacon")==0)
                                continue;
                            Field *fieldPtr = fcPtr->getField(i);
                            const FieldType &fType = fieldPtr->getType();
                            const char *ptrStr = strstr(fType.getCName(), "Ptr");
                            if(ptrStr && strlen(ptrStr) == 3)
                            {
                                if(fieldPtr->getCardinality() == FieldType::SINGLE_FIELD)
                                {
                                    ((SFFieldContainerPtr *)fieldPtr)->setValue(NullFC);
                                }
                                else 
                                {
                                    ((MFFieldContainerPtr *) fieldPtr)->clear();
                                }
                            }
                        }

                        // subref until the factory hat no 
                        // knowlage of the node
                        // we can do this here because in sendSync the destroys are coming
                        // after the changes, that's important because if
                        // rebuildState would be called
                        // after the StateChunk has been destroyed this would lead to some
                        // problems because the StateChunk is also referenced
                        // in the state and in the next rebuildState of the material
                        // the old already invalid chunk ptr is destroyed again!
                        do
                        {
                            subRefCP(fcPtr);
                            fcPtr = factory->getContainer(localId);
                        }
                        while(fcPtr != NullFC);
                    }
                }
                else
                {
                    SWARNING <<
                        "Can't destroy unknown FC:" <<
                        remoteId << " " <<
                        std::endl;
                }
                break;
            }

        case CHANGED:
            {
                connection.getValue(remoteId);
                connection.getValue(mask);
                connection.getValue(len);

                if(getLocalId(remoteId,localId))
                {
                    fcPtr = factory->getContainer(localId);

                    if(applyToChangelist)
                    {
                        beginEditCP(fcPtr, mask);
                    }

                    /*
                    for(int i=0;i<fcPtr->getType().getNumFieldDescs();i++)
                    {
                        FieldDescription *desc=fcPtr->getType().getFieldDescription(i+1);
                        if(desc->getFieldMask() & mask)
                            cout<< "changed field: " << desc->getName() << std::endl;
                    }
                    */
                    fcPtr->copyFromBin(connection, mask);
                    if(applyToChangelist)
                    {
                        endEditCP(fcPtr, mask);
                    }
                    else
                    {
                        // do we need to call this?
                        changedCP(fcPtr, mask);
                    }
                    changedFCs.push_back(
                        std::pair<FieldContainerPtr,BitVector>(
                            fcPtr,mask));
                }
                else
                {
                    char dummy;

                    SWARNING <<
                        "Can't change unknown FC:" <<
                        remoteId << " skip " << len << " bytes." <<
                        std::endl;
                    while(len--)
                        connection.get(&dummy,1);
                }
                break;
            }

        case SYNCENDED:
            {
                finish = true;
                break;
            }

        case ADDREFED:
            {
                connection.getValue(remoteId);
                if(getLocalId(remoteId,localId))
                {
                    fcPtr = factory->getContainer(localId);
                    FDEBUG(("AddRef: %s ID:%d\n", 
                            fcPtr->getType().getName().str(),
                            fcPtr.getFieldContainerId())) 
                    addRefCP(fcPtr);
                }
                else
                {
                    FDEBUG(("Can't addref unknown FC:%d\n", remoteId));
                }
                break;
            }

        case SUBREFED:
            {
                connection.getValue(remoteId);
                if(getLocalId(remoteId,localId))
                {
                    fcPtr = factory->getContainer(localId);
                    FDEBUG(("SubRef: %s ID:%d\n", 
                            fcPtr->getType().getName().str(),
                            fcPtr.getFieldContainerId()))
#if 0
                    //ignore until solution is found for subrefs in destructors
                    subRefCP(fcPtr);
#endif
                }
                else
                {
                    FDEBUG(("Can't subref unknown FC:%d\n", remoteId));
                }
                break;
            }
        case IDMAPPING:
            {
                connection.getValue(remoteId);
                connection.getValue(localAspect);
                connection.getValue(localId);
                if(localAspect != _aspectId)
                {
                    SFATAL << "ID mapping for wrong aspect" << std::endl;
                }

                // local <-> remote mapping
                fullRemoteId = getFullRemoteId(remoteId);
                _localFC[fullRemoteId] = localId;
                break;
            }
        default:
            {
                SFATAL << "Unknown tag:" << (int) cmd << std::endl;
                throw RemoteSyncError();
            }
        }
    } 
    while(!finish);

    // call changed for all changed field containers after all values
    // are set
    for(std::vector<std::pair<FieldContainerPtr,BitVector> >::iterator cI=changedFCs.begin();
        cI != changedFCs.end();
        ++cI) 
    {
        changedCP(cI->first,cI->second);
        callChanged(cI->first);
    }

    // unregister mapper into factory
    factory->setMapper(NULL);

    if(_statistics)
    {
        _statistics->getElem(statSyncTime)->stop();
    }
}

void RemoteAspect::sendSync	(	Connection &	connection,
		ChangeList *	changeList = NULL
	)

All changes from changeList are send to the connecteion except the fields which are filtered. Filters are used to avoid transmission of local states. e.g. GL variables.

Definition at line 514 of file OSGRemoteAspect.cpp.

References _aspectId, _fieldFilter, _mappedFC, _mappedType, _sentFC, _statistics, ADDREFED, osg::ChangeList::beginAddRefd(), osg::ChangeList::beginChanged(), osg::ChangeList::beginCreated(), osg::ChangeList::beginDestroyed(), osg::ChangeList::beginSubRefd(), CHANGED, clearFCMapping(), CREATED, DESTROYED, osg::ChangeList::endAddRefd(), osg::ChangeList::endChanged(), osg::ChangeList::endCreated(), osg::ChangeList::endDestroyed(), osg::ChangeList::endSubRefd(), FDEBUG, osg::BinaryDataHandler::flush(), osg::FieldContainerFactory::getContainer(), osg::StatCollector::getElem(), osg::FieldContainerPtrBase::getFieldContainerId(), handleFCMapping(), NEWTYPE, osg::NullFC, osg::BinaryDataHandler::putValue(), statSyncTime, SUBREFED, SYNCENDED, and osg::FieldContainerFactory::the().

Referenced by osg::ClusterWindow::frameInit().

{
    ChangeList::changed_const_iterator  changedI;
    ChangeList::idrefd_const_iterator   createdI;
    ChangeList::idrefd_const_iterator   destroyedI;
    ChangeList::refd_const_iterator     addRefedI;
    ChangeList::refd_const_iterator     subRefedI;
    FieldFilterT::iterator              filterI;
    FieldContainerFactory               *fcFactory = FieldContainerFactory::the();
    FieldContainerPtr                   fcPtr;
    UInt32                              typeId;
    BitVector                           mask;
    UInt8                               cmd;
    std::string                         typeName;
    FieldMaskMapT::iterator             sentFCI;
    FieldMaskMapT                       changedMap;
    FieldMaskMapT::iterator             changedMapI;
    UInt32                              len;

    if(_statistics)
    {
        _statistics->getElem(statSyncTime)->start();
    }

    if(!changeList)
    {
        changeList = OSG::Thread::getCurrentChangeList();
    }

    // tell my aspect id
    connection.putValue(_aspectId);

    handleFCMapping(connection);

    // created fct
    for(createdI = changeList->beginCreated();
        createdI != changeList->endCreated(); createdI++)
    {
        fcPtr = fcFactory->getContainer(*createdI);
        if(fcPtr == NullFC)
        {
            continue;
        }

        typeId = fcPtr->getTypeId();

        // type unknown by remote context ?
        if(_mappedType.count(typeId) == 0)
        {
            // mark type as known
            _mappedType.insert(typeId);

            // send new type
            cmd = NEWTYPE;
            typeName = fcPtr->getType().getName().str();
            connection.putValue(cmd);
            connection.putValue(typeId);
            connection.putValue(typeName);
        }

        cmd = CREATED;
        connection.putValue(cmd);
        connection.putValue(typeId);
        connection.putValue(*createdI);

        // sent container to create
        _sentFC.insert(*createdI);
        // fc is known by remote
        _mappedFC.insert(*createdI);

    }

    // changed fields
    // first create a condensed map, where each container is stored
    // only once
    for(changedI = changeList->beginChanged();
        changedI != changeList->endChanged(); 
        changedI++)
    {
        changedMapI = changedMap.find(changedI->first);
        if(changedMapI == changedMap.end())
        {
            changedMap.insert(std::pair < UInt32,
                                          BitVector > (changedI->first, changedI->second));
        }
        else
        {
            changedMapI->second |= changedI->second;
        }
    }

    for(FieldMaskMapT::iterator condensedI = changedMap.begin();
        condensedI != changedMap.end();
        ++condensedI)
    {
        if(_mappedFC.count(condensedI->first)==0)
            continue;

        FieldContainerPtr fcPtr = 
            FieldContainerFactory::the()->getContainer(condensedI->first);

        // ignore removed containers
        if(fcPtr == NullFC)
            continue;
        mask = condensedI->second;

        // apply field filter
        filterI = _fieldFilter.find(fcPtr->getType().getId());
        if(filterI != _fieldFilter.end())
        {
            FDEBUG(("SyncFieldFilter: :%s \n", 
                    fcPtr->getType().getName().str() )) 
            mask &= TypeTraits<BitVector>::BitsSet ^ filterI->second;
        }

        if(mask)
        {
            // send changes
            condensedI->second |= mask;
            cmd = CHANGED;
            connection.putValue(cmd);
            connection.putValue(condensedI->first); // id
            connection.putValue(mask);              // mask
            len = fcPtr->getBinSize(mask);
            connection.putValue(len);
            fcPtr->copyToBin(connection, mask);
            FDEBUG(("Changed: %s ID:%d Mask:%lld\n", 
                    fcPtr->getType().getName().str(),
                    fcPtr.getFieldContainerId(), 
                    mask))
        }
    }

    // destroy fct
    // needs to be called after the changes (see receiveSync for more info)!!!
    for(destroyedI = changeList->beginDestroyed();
        destroyedI != changeList->endDestroyed(); destroyedI++)
    {
        UInt32  id = (*destroyedI);

        // is it a known container
        if(_mappedFC.count(id))
        {
            clearFCMapping(id,0);
            cmd = DESTROYED;
            connection.putValue(cmd);
            connection.putValue(id);
        }
    }

    // addref
    for(addRefedI = changeList->beginAddRefd();
        addRefedI != changeList->endAddRefd();
        ++addRefedI)
    {
        UInt32  id = (*addRefedI);

        if(_mappedFC.count(id)==0)
            continue;
        cmd = ADDREFED;
        connection.putValue(cmd);
        connection.putValue(id);
    }

    // subref
    for(subRefedI = changeList->beginSubRefd();
        subRefedI != changeList->endSubRefd();
        ++subRefedI)
    {
        UInt32  id = (*subRefedI);

        // ignore addrefs for unknown fcs
        if(_mappedFC.count(id)==0)
            continue;
        cmd = SUBREFED;
        connection.putValue(cmd);
        connection.putValue(id);
    }

    cmd = SYNCENDED;
    connection.putValue(cmd);

    // write buffer
    connection.flush();

    if(_statistics)
    {
        _statistics->getElem(statSyncTime)->stop();
    }
}

void RemoteAspect::registerCreated	(	const FieldContainerType &	type,
		const Functor &	func
	)

The given functor is called when a create of the specified type is received.

See also:

receiveSync

Definition at line 710 of file OSGRemoteAspect.cpp.

References _createdFunctors, _defaultCreatedFunction(), osg::TypeBase::getId(), and osg::osgTypedFunctionFunctor2CPtrRef().

{
    while(type.getId() >= _createdFunctors.size())
    {
        _createdFunctors.push_back(
            osgTypedFunctionFunctor2CPtrRef
            <bool,FieldContainerPtr,RemoteAspect * >
            (&_defaultCreatedFunction));
    }

    _createdFunctors[type.getId()] = func;
}

void RemoteAspect::registerDestroyed	(	const FieldContainerType &	type,
		const Functor &	func
	)

The given functor is called when a destroy of the specified type is received.

See also:

receiveSync

Definition at line 729 of file OSGRemoteAspect.cpp.

References _defaultDestroyedFunction(), _destroyedFunctors, osg::TypeBase::getId(), and osg::osgTypedFunctionFunctor2CPtrRef().

{
    while(type.getId() >= _destroyedFunctors.size())
    {
        _destroyedFunctors.push_back(osgTypedFunctionFunctor2CPtrRef < bool,
                                             FieldContainerPtr, RemoteAspect * > (&_defaultDestroyedFunction));
    }

    _destroyedFunctors[type.getId()] = func;
}

void RemoteAspect::registerChanged	(	const FieldContainerType &	type,
		const Functor &	func
	)

The given functor is called when a change of the specified type is received.

See also:

receiveSync

Definition at line 746 of file OSGRemoteAspect.cpp.

References _changedFunctors, _defaultChangedFunction(), osg::TypeBase::getId(), and osg::osgTypedFunctionFunctor2CPtrRef().

Referenced by osg::ClusterServer::start().

{
    while(type.getId() >= _changedFunctors.size())
    {
        _changedFunctors.push_back(osgTypedFunctionFunctor2CPtrRef < bool,
                                           FieldContainerPtr,
                                           RemoteAspect * > (&_defaultChangedFunction));
    }

    _changedFunctors[type.getId()] = func;
}

void RemoteAspect::addFieldFilter	(	UInt32	typeId,
		BitVector	mask
	)			[static]

add a new field filter. The given fieldmaks will not be transfered

Definition at line 761 of file OSGRemoteAspect.cpp.

References _fieldFilter.

Referenced by osg::SHLChunk::onCreate().

{
    _fieldFilter[typeId] |= mask;
}

void RemoteAspect::subFieldFilter	(	UInt32	typeId,
		BitVector	mask
	)			[static]

remove the filter for the given type and mask

Definition at line 768 of file OSGRemoteAspect.cpp.

References _fieldFilter.

{
    _fieldFilter[typeId] &= ~mask;
}

void RemoteAspect::restoreChangeList

(

ChangeList *

tocl

)

[static]

creates a changelist from the store and merges this to the changelist.

Definition at line 775 of file OSGRemoteAspect.cpp.

References _clStore, osg::ChangeList::addAddRefd(), osg::ChangeList::addChanged(), osg::ChangeList::addCreated(), osg::FieldBits::AllFields, osg::FieldContainerFactory::getContainer(), osg::NullFC, and osg::FieldContainerFactory::the().

Referenced by osg::ChangeList::addChanged().

{
    for(clStoreIt i = _clStore.begin();i != _clStore.end(); ++i)
    {
        UInt32 id = (*i).first;
        FieldContainerPtr fc = FieldContainerFactory::the()->getContainer(id);
        if(fc != NullFC)
        {
            tocl->addCreated(id);
            for(UInt32 j=0;j<(*i).second;++j)
                tocl->addAddRefd(fc);
            tocl->addChanged(fc, FieldBits::AllFields);
        }
    }
}

void RemoteAspect::storeChangeList

(

ChangeList *

cl

)

[static]

store all created, addRefd, subRefd, destroyed into the clStore.

Definition at line 793 of file OSGRemoteAspect.cpp.

References _clStore, osg::ChangeList::beginAddRefd(), osg::ChangeList::beginCreated(), osg::ChangeList::beginDestroyed(), osg::ChangeList::beginSubRefd(), osg::ChangeList::endAddRefd(), osg::ChangeList::endCreated(), osg::ChangeList::endDestroyed(), and osg::ChangeList::endSubRefd().

Referenced by osg::ChangeList::addChanged().

{
    // created
    for(ChangeList::idrefd_const_iterator i = cl->beginCreated(); i != cl->endCreated(); ++i)
    {
        clStoreIt ci = _clStore.find(*i);
        if(ci == _clStore.end())
            _clStore.insert(std::pair<UInt32, UInt32>(*i, 0));
    }

    // addRef
    for(ChangeList::idrefd_const_iterator i = cl->beginAddRefd(); i != cl->endAddRefd(); ++i)
    {
        clStoreIt ci = _clStore.find(*i);
        if(ci != _clStore.end())
            (*ci).second++;
        //else
        //    FWARNING(("Called addRef on a not created fieldcontainer!\n"));
    }
    
    // subRef
    for(ChangeList::idrefd_const_iterator i = cl->beginSubRefd(); i != cl->endSubRefd(); ++i)
    {
        clStoreIt ci = _clStore.find(*i);
        if(ci != _clStore.end())
            (*ci).second--;
        //else
        //    FWARNING(("Called subRef on a not created fieldcontainer!\n"));
    }
    
    // destroyed
    for(ChangeList::idrefd_const_iterator i = cl->beginDestroyed(); i != cl->endDestroyed(); ++i)
    {
        clStoreIt ci = _clStore.find(*i);
        if(ci != _clStore.end())
            _clStore.erase(ci);
    }
}

UInt32 RemoteAspect::getStoreSize

(

void

)

[static]

Definition at line 832 of file OSGRemoteAspect.cpp.

References _clStore.

{
    return _clStore.size();
}

RemoteAspect::clStoreMap & RemoteAspect::getStore

(

void

)

[static]

Definition at line 837 of file OSGRemoteAspect.cpp.

References _clStore.

{
    return _clStore;
}

void RemoteAspect::createCurrentStateChangeList	(	const FieldContainerPtr &	start,
		ChangeList *	cl
	)			[static]

Definition at line 842 of file OSGRemoteAspect.cpp.

References osg::ChangeList::addAddRefd(), osg::ChangeList::addChanged(), osg::ChangeList::addCreated(), osg::FieldBits::AllFields, osg::ChangeList::clearAll(), osg::FieldContainerPtrBase::getFieldContainerId(), osg::FieldContainerFactory::getFieldContainerStore(), osg::FieldContainerPtrBase::getRefCount(), osg::NullFC, and osg::FieldContainerFactory::the().

{
    if(cl == NULL)
        return;

    cl->clearAll();
    const std::vector<FieldContainerPtr> &fcs = *FieldContainerFactory::the()->getFieldContainerStore();

    bool found_start = false;
    for(unsigned int i=0;i<fcs.size();++i)
    {
        FieldContainerPtr fc = fcs[i];
        if(fc != NullFC)
        {
            if(fc == start)
                found_start = true;

            if(found_start)
            {
                cl->addCreated(fc.getFieldContainerId());
                for(UInt32 j=0;j<fc.getRefCount();++j)
                    cl->addAddRefd(fc);
                cl->addChanged(fc, FieldBits::AllFields);
            }
        }
    } 
}

void RemoteAspect::setStatistics

(

StatCollector *

statistics

)

Set statistics collector

Definition at line 875 of file OSGRemoteAspect.cpp.

References _statistics.

Referenced by osg::ClusterWindow::init(), and osg::ClusterWindow::setStatistics().

{
    _statistics = statistics;
}

bool RemoteAspect::callCreated

(

FieldContainerPtr &

fcp

)

[protected]

Call created functor for a given FieldContainer

See also:

registerCreated

Definition at line 887 of file OSGRemoteAspect.cpp.

References _createdFunctors, and _defaultCreatedFunction().

Referenced by receiveSync().

{
    bool    result;
    UInt32  uiFunctorIndex = fcp->getType().getId();

    if(uiFunctorIndex < _createdFunctors.size())
    {
        result = _createdFunctors[uiFunctorIndex].call(fcp, this);
    }
    else
    {
        result = _defaultCreatedFunction(fcp, this);
    }

    return result;
}

bool RemoteAspect::callDestroyed

(

FieldContainerPtr &

fcp

)

[protected]

Call destroyed functor for a given FieldContainer

See also:

registerDestroyed

Definition at line 908 of file OSGRemoteAspect.cpp.

References _defaultDestroyedFunction(), and _destroyedFunctors.

Referenced by receiveSync(), and ~RemoteAspect().

{
    bool    result;
    UInt32  uiFunctorIndex = fcp->getType().getId();

    if(uiFunctorIndex < _destroyedFunctors.size())
    {
        result = _destroyedFunctors[uiFunctorIndex].call(fcp, this);
    }
    else
    {
        result = _defaultDestroyedFunction(fcp, this);
    }

    return result;
}

bool RemoteAspect::callChanged

(

FieldContainerPtr &

fcp

)

[protected]

Call changed functor for a given FieldContainer

See also:

registerChanged

Definition at line 929 of file OSGRemoteAspect.cpp.

References _changedFunctors, and _defaultChangedFunction().

Referenced by receiveSync().

{
    bool    result;
    UInt32  uiFunctorIndex = fcp->getType().getId();

    if(uiFunctorIndex < _changedFunctors.size())
    {
        result = _changedFunctors[uiFunctorIndex].call(fcp, this);
    }
    else
    {
        result = _defaultChangedFunction(fcp, this);
    }

    return result;
}

void RemoteAspect::handleFCMapping

(

Connection &

connection

)

[private]

This is called if a fc was edited that was created by another aspect

Definition at line 949 of file OSGRemoteAspect.cpp.

References _mappedFC, _remoteFC, IDMAPPING, and osg::BinaryDataHandler::putValue().

Referenced by sendSync().

{
    UInt8  cmd;
    UInt32 remoteId;
    UInt32 remoteAspect;
    RemoteFCMapT::iterator remoteFCI;

    for(remoteFCI = _remoteFC.begin() ;
        remoteFCI != _remoteFC.end() ;
        ++remoteFCI)
    {
        remoteId     = (UInt32)(remoteFCI->second);
        remoteAspect = (UInt32)(remoteFCI->second>>32);

        cmd = IDMAPPING;
        connection.putValue(cmd);
        connection.putValue(remoteFCI->first);
        connection.putValue(remoteAspect);
        connection.putValue(remoteId);

        _mappedFC.insert(remoteFCI->first);
    }
    _remoteFC.clear();
}

void RemoteAspect::clearFCMapping	(	UInt32	localId,
		UInt32	remoteId
	)			[private]

clear maps from local id

Definition at line 976 of file OSGRemoteAspect.cpp.

References _localFC, _mappedFC, _receivedFC, _remoteFC, and _sentFC.

Referenced by receiveSync(), and sendSync().

{
    _mappedFC.erase(localId);
    _sentFC.erase(localId);
    _receivedFC.erase(localId);

    if(!remoteId)
    {
        RemoteFCMapT::iterator remoteFCI=_remoteFC.find(localId);
        if(remoteFCI != _remoteFC.end())
            remoteId=static_cast<UInt32>(remoteFCI->second);
    }
    
    RemoteFCMapT::iterator remoteFCI=_remoteFC.find(localId);
    if(remoteFCI != _remoteFC.end())
        _remoteFC.erase(remoteFCI);

    LocalFCMapT::iterator localFCI=_localFC.find(remoteId);
    if(localFCI != _localFC.end())
        _localFC.erase(localFCI);
    
}

bool RemoteAspect::getLocalId	(	UInt32	remoteId,
		UInt32 &	localId
	)			[private]

get local id mapped from remote id

Definition at line 1001 of file OSGRemoteAspect.cpp.

References _localFC, and getFullRemoteId().

Referenced by receiveSync().

{
    UInt64 fullRemoteId = getFullRemoteId(remoteId);
    LocalFCMapT::iterator localFCI=_localFC.find(fullRemoteId);

    if( localFCI != _localFC.end() )
    {
        localId=localFCI->second;
        return true;
    }
    else
    {
        return false;
    }
}

UInt64 RemoteAspect::getFullRemoteId

(

UInt32

remoteId

)

[private]

This is called if a fc was edited that was created by another aspect

Definition at line 1018 of file OSGRemoteAspect.cpp.

References _remoteAspectId.

Referenced by getLocalId(), osg::RemoteAspectFieldContainerMapper::map(), and receiveSync().

{
    UInt64 remoteId=_remoteAspectId;
    remoteId<<=32;
    remoteId|=fcId;
    return remoteId;
}

bool RemoteAspect::_defaultCreatedFunction	(	FieldContainerPtr &	fcp,
		RemoteAspect *	aspect
	)			[static, private]

Default create functor

Definition at line 1037 of file OSGRemoteAspect.cpp.

References FDEBUG, and osg::FieldContainerPtrBase::getFieldContainerId().

Referenced by callCreated(), and registerCreated().

{
    FDEBUG(("Created:%s %d\n", 
            fcp->getType().getName().str(),
            fcp.getFieldContainerId()))
    return true;
}

bool RemoteAspect::_defaultDestroyedFunction	(	FieldContainerPtr &	fcp,
		RemoteAspect *	aspect
	)			[static, private]

Default destroyed functor

Definition at line 1047 of file OSGRemoteAspect.cpp.

References FDEBUG, and osg::FieldContainerPtrBase::getFieldContainerId().

Referenced by callDestroyed(), and registerDestroyed().

{
    FDEBUG(("Destroyed:%s %d\n",
            fcp->getType().getName().str(),
            fcp.getFieldContainerId()))
    return true;
}

bool RemoteAspect::_defaultChangedFunction	(	FieldContainerPtr &	fcp,
		RemoteAspect *	aspect
	)			[static, private]

Default changed functor

Definition at line 1058 of file OSGRemoteAspect.cpp.

References FDEBUG, and osg::FieldContainerPtrBase::getFieldContainerId().

Referenced by callChanged(), and registerChanged().

{
    FDEBUG(("Changed:%s %d\n", 
            fcp->getType().getName().str(),
            fcp.getFieldContainerId()))
    return true;
}

RemoteAspect& osg::RemoteAspect::operator=

(

const RemoteAspect &

source

)

[private]

---

Friends And Related Function Documentation

friend class RemoteAspectFieldContainerMapper [friend]

Definition at line 221 of file OSGRemoteAspect.h.

---

Member Data Documentation

UInt32 osg::RemoteAspect::_aspectId [protected]

Aspect id

Definition at line 149 of file OSGRemoteAspect.h.

Referenced by receiveSync(), and sendSync().

LocalFCMapT osg::RemoteAspect::_localFC [protected]

remote id to fieldcontainer mapping

Definition at line 152 of file OSGRemoteAspect.h.

Referenced by clearFCMapping(), getLocalId(), osg::RemoteAspectFieldContainerMapper::map(), and receiveSync().

RemoteFCMapT osg::RemoteAspect::_remoteFC [protected]

local to remote fieldcontainer mapping

Definition at line 154 of file OSGRemoteAspect.h.

Referenced by clearFCMapping(), handleFCMapping(), and receiveSync().

LocalTypeMapT osg::RemoteAspect::_localType [protected]

remote typeid mapping

Definition at line 156 of file OSGRemoteAspect.h.

Referenced by receiveSync().

IdSetT osg::RemoteAspect::_sentFC [protected]

indicates fc was sent

Definition at line 159 of file OSGRemoteAspect.h.

Referenced by clearFCMapping(), and sendSync().

IdSetT osg::RemoteAspect::_receivedFC [protected]

indicates fc was received

Definition at line 161 of file OSGRemoteAspect.h.

Referenced by clearFCMapping(), receiveSync(), and ~RemoteAspect().

IdSetT osg::RemoteAspect::_mappedFC [protected]

indicates remote knows this fc

Definition at line 164 of file OSGRemoteAspect.h.

Referenced by clearFCMapping(), handleFCMapping(), and sendSync().

IdSetT osg::RemoteAspect::_mappedType [protected]

indicates mapped type

Definition at line 166 of file OSGRemoteAspect.h.

Referenced by sendSync().

UInt32 osg::RemoteAspect::_remoteAspectId [protected]

Aspect id

Definition at line 168 of file OSGRemoteAspect.h.

Referenced by getFullRemoteId(), and receiveSync().

RemoteAspect::FieldFilterT RemoteAspect::_fieldFilter [static, protected]

fild filter

Definition at line 176 of file OSGRemoteAspect.h.

Referenced by addFieldFilter(), RemoteAspect(), sendSync(), and subFieldFilter().

std::vector<Functor> osg::RemoteAspect::_createdFunctors [protected]

Aspect id

Definition at line 177 of file OSGRemoteAspect.h.

Referenced by callCreated(), and registerCreated().

std::vector<Functor> osg::RemoteAspect::_destroyedFunctors [protected]

Aspect id

Definition at line 178 of file OSGRemoteAspect.h.

Referenced by callDestroyed(), and registerDestroyed().

std::vector<Functor> osg::RemoteAspect::_changedFunctors [protected]

Aspect id

Definition at line 179 of file OSGRemoteAspect.h.

Referenced by callChanged(), and registerChanged().

StatCollector* osg::RemoteAspect::_statistics [protected]

Aspect id

Definition at line 180 of file OSGRemoteAspect.h.

Referenced by receiveSync(), sendSync(), and setStatistics().

std::map< UInt32, UInt32 > RemoteAspect::_clStore [static, protected]

Aspect id

Definition at line 182 of file OSGRemoteAspect.h.

Referenced by getStore(), getStoreSize(), restoreChangeList(), and storeChangeList().

StatElemDesc< StatTimeElem > RemoteAspect::statSyncTime [static, private]

Definition at line 218 of file OSGRemoteAspect.h.

Referenced by receiveSync(), and sendSync().

---

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

• OSGRemoteAspect.h
• OSGRemoteAspect.cpp