nBandwidthArbitrator Class Reference

#include <nPriorizing.h>

Inheritance diagram for nBandwidthArbitrator:

[legend]

Collaboration diagram for nBandwidthArbitrator:

[legend]

List of all members.

Public Member Functions
bool	Fill (nSendBuffer &buffer, nBandwidthControl &control)
void	Timestep (REAL dt)
bool	UseBandwidth (REAL dt)
Protected Member Functions
	nBandwidthArbitrator ()
	~nBandwidthArbitrator ()
Private Member Functions
nType	FirstType () const
virtual void	OnChange ()
virtual bool	DoUseBandwidth (REAL dt)=0
virtual tHeapBase *	Heap () const
virtual REAL	TimeScale ()
virtual REAL	PacketOverhead ()
Private Attributes
nBandwidthSceduler *	sceduler_
Friends
class	nBandwidthSceduler
class	tReferencable< nBandwidthArbitrator >

---

Detailed Description

Definition at line 119 of file nPriorizing.h.

---

Constructor & Destructor Documentation

nBandwidthArbitrator::nBandwidthArbitrator

(

)

[protected]

Definition at line 134 of file nPriorizing.cpp.

References NULL, and sceduler_.

{
    sceduler_ = NULL;
}

nBandwidthArbitrator::~nBandwidthArbitrator

(

)

[protected]

Definition at line 139 of file nPriorizing.cpp.

References NULL, nBandwidthSceduler::RemoveArbitrator(), tHeapElement::RemoveFromHeap(), sceduler_, and tASSERT.

{
    if ( sceduler_ )
    {
        sceduler_->RemoveArbitrator( *this );
    }

    tASSERT( NULL == sceduler_ );

    this->RemoveFromHeap();
}

Here is the call graph for this function:

---

Member Function Documentation

bool nBandwidthArbitrator::Fill	(	nSendBuffer &	buffer,
		nBandwidthControl &	control
	)

Definition at line 152 of file nPriorizing.cpp.

References FirstType(), Heap(), nBandwidthTaskPriorizer::Next(), nBandwidthTaskPriorizer::PeekNext(), REAL, nBandwidthControl::Score(), and tHeapElement::SetVal().

Referenced by nBandwitdhDistributor::DoUseBandwidth().

{
    // return whether a message was sent
    bool ret = false;

    // find heap to use
    nType type = this->FirstType();
    if ( type < nBandwidthTask::Type_Count )
    {
        REAL totalPriority = 0.0f;                              // total prioirty of already added messages

        bool first = true;
        bool goon = true;
        while ( goon )
        {
            goon = false;

            tJUST_CONTROLLED_PTR< nBandwidthTask > next = this->PeekNext( type );
            if ( next )
            {
                REAL priority = next->Priority();
                REAL value = next->Val();

                // see if we have enough bandwidth reservers to send message
                if ( !first || value  * this->TimeScale() > -control.Score() )
                {
                    // see if the priority of the next sent message justifies the delay caused for the messages already in the buffer
                    if ( priority * this->PacketOverhead() > totalPriority * next->EstimateSize() )
                    {
                        // extract message
                        next = this->Next( type );

                        // send it
                        next->Execute( buffer, control );

                        // sum up priority
                        totalPriority += priority;

                        // try another one!
                        goon = true;
                        ret = true;
                    }
                }
            }

            first = false;
        }
    }

    // reduce priority so it is not picked until the next call to Timestep
    this->SetVal( this->Val() - 100.0f, *this->Heap() );

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nBandwidthArbitrator::Timestep

(

REAL

dt

)

Definition at line 208 of file nPriorizing.cpp.

References GrowingArrayBase::Len(), tHeap< T >::Len(), OnChange(), tArray< T, MALLOC >::SetLen(), and nBandwidthTaskPriorizer::Tasks().

{
    for ( int i = 0; i < nBandwidthTask::Type_Count; ++i )
    {
        nType type = nType(i);

        nTaskHeap& heap = this->Tasks( type );
        int j;

        static tArray< nBandwidthTask* > tasks;
        tasks.SetLen( 0 );

        // copy heap; otherwise, we would risk updating elements twice or not al all
        for ( j = heap.Len()-1; j>=0; --j )
        {
            tasks[j] = heap(j);
        }

        for ( j = tasks.Len()-1; j>=0; --j )
        {
            tasks(j)->Timestep( dt );
        }
    }

    this->OnChange();
}

Here is the call graph for this function:

bool nBandwidthArbitrator::UseBandwidth

(

REAL

dt

)

[inline]

Definition at line 127 of file nPriorizing.h.

References DoUseBandwidth().

Referenced by nBandwidthSceduler::UseBandwidth().

{ return DoUseBandwidth( dt ); }        // consumes some bandwidth

Here is the call graph for this function:

Here is the caller graph for this function:

nBandwidthArbitrator::nType nBandwidthArbitrator::FirstType

(

)

const [private]

Definition at line 236 of file nPriorizing.cpp.

Referenced by Fill().

{
    for ( int i = 0; i < nBandwidthTask::Type_Count; ++i )
    {
        nType type = nType(i);
        if ( this->Tasks(type).Len() > 0 )
        {
            return type;
        }
    }

    return nBandwidthTask::Type_Count;
}

Here is the caller graph for this function:

void nBandwidthArbitrator::OnChange

(

)

[private, virtual]

Reimplemented from nBandwidthTaskPriorizer.

Definition at line 251 of file nPriorizing.cpp.

References tHeap< T >::Len(), REAL, tHeapElement::SetVal(), and nBandwidthTaskPriorizer::Tasks().

Referenced by Timestep().

{
    REAL value = 0.0f;

    for ( int i = 0; i < nBandwidthTask::Type_Count; ++i )
    {
        nType type = nType(i);
        const nTaskHeap& heap = this->Tasks(type);
        if ( heap.Len() > 0 )
        {
            value += heap(0)->Val();
        }
    }

    this->SetVal( value, *this->Heap() );
}

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool nBandwidthArbitrator::DoUseBandwidth

(

REAL

dt

)

[private, pure virtual]

Implemented in nBandwitdhDistributor.

Referenced by UseBandwidth().

Here is the caller graph for this function:

tHeapBase * nBandwidthArbitrator::Heap

(

)

const [private, virtual]

Implements tHeapElement.

Definition at line 268 of file nPriorizing.cpp.

References nBandwidthSceduler::arbitratorHeap_, NULL, and sceduler_.

Referenced by Fill().

{
    if ( !sceduler_ )
    {
        return NULL;
    }

    return &sceduler_->arbitratorHeap_;
}

Here is the caller graph for this function:

virtual REAL nBandwidthArbitrator::TimeScale

(

)

[inline, private, virtual]

Reimplemented in nBandwitdhDistributor.

Definition at line 137 of file nPriorizing.h.

{ return 0.1f; }                                                // higher values let really urgent messages be sent even if the bandwidth control objectd

virtual REAL nBandwidthArbitrator::PacketOverhead

(

)

[inline, private, virtual]

Reimplemented in nBandwitdhDistributor.

Definition at line 138 of file nPriorizing.h.

{ return 60.0f; }                                       // overhead in bytes per sent packet. Determines average package size

---

Friends And Related Function Documentation

friend class nBandwidthSceduler [friend]

Definition at line 121 of file nPriorizing.h.

friend class tReferencable< nBandwidthArbitrator > [friend]

Definition at line 122 of file nPriorizing.h.

---

Member Data Documentation

nBandwidthSceduler* nBandwidthArbitrator::sceduler_ [private]

Definition at line 140 of file nPriorizing.h.

Referenced by nBandwidthSceduler::AddArbitrator(), Heap(), nBandwidthArbitrator(), nBandwidthSceduler::RemoveArbitrator(), and ~nBandwidthArbitrator().

---

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

• src/network/nPriorizing.h
• src/network/nPriorizing.cpp

---