OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Classes | Public Member Functions | Public Attributes | Properties | List of all members
OpenSim.Framework.PriorityQueue Class Reference

Public Member Functions

delegate bool UpdatePriorityHandler (ref uint priority, ISceneEntity entity)
 
 PriorityQueue ()
 
 PriorityQueue (int capacity)
 
bool Enqueue (uint pqueue, IEntityUpdate value)
 Enqueue an item into the specified priority queue More...
 
void Remove (List< uint > ids)
 
bool TryDequeue (out IEntityUpdate value, out Int32 timeinqueue)
 Remove an item from one of the queues. Specifically, it removes the oldest item from the next queue in order to provide fair access to all of the queues More...
 
void Reprioritize (UpdatePriorityHandler handler)
 Reapply the prioritization function to each of the updates currently stored in the priority queues. </summary More...
 
override string ToString ()
 

Public Attributes

const uint NumberOfQueues = 12
 Total number of queues (priorities) available More...
 
const uint NumberOfImmediateQueues = 2
 Number of queuest (priorities) that are processed immediately </summary. More...
 

Properties

object SyncRoot [get]
 
int Count [get]
 Return the number of items in the queues More...
 

Detailed Description

Definition at line 39 of file PriorityQueue.cs.

Constructor & Destructor Documentation

OpenSim.Framework.PriorityQueue.PriorityQueue ( )
inline

Definition at line 83 of file PriorityQueue.cs.

OpenSim.Framework.PriorityQueue.PriorityQueue ( int  capacity)
inline

Definition at line 85 of file PriorityQueue.cs.

Member Function Documentation

bool OpenSim.Framework.PriorityQueue.Enqueue ( uint  pqueue,
IEntityUpdate  value 
)
inline

Enqueue an item into the specified priority queue

Definition at line 116 of file PriorityQueue.cs.

void OpenSim.Framework.PriorityQueue.Remove ( List< uint >  ids)
inline

Definition at line 138 of file PriorityQueue.cs.

void OpenSim.Framework.PriorityQueue.Reprioritize ( UpdatePriorityHandler  handler)
inline

Reapply the prioritization function to each of the updates currently stored in the priority queues. </summary

Definition at line 223 of file PriorityQueue.cs.

override string OpenSim.Framework.PriorityQueue.ToString ( )
inline

Definition at line 260 of file PriorityQueue.cs.

bool OpenSim.Framework.PriorityQueue.TryDequeue ( out IEntityUpdate  value,
out Int32  timeinqueue 
)
inline

Remove an item from one of the queues. Specifically, it removes the oldest item from the next queue in order to provide fair access to all of the queues

Definition at line 157 of file PriorityQueue.cs.

delegate bool OpenSim.Framework.PriorityQueue.UpdatePriorityHandler ( ref uint  priority,
ISceneEntity  entity 
)

Member Data Documentation

const uint OpenSim.Framework.PriorityQueue.NumberOfImmediateQueues = 2

Number of queuest (priorities) that are processed immediately </summary.

Definition at line 54 of file PriorityQueue.cs.

const uint OpenSim.Framework.PriorityQueue.NumberOfQueues = 12

Total number of queues (priorities) available

Definition at line 49 of file PriorityQueue.cs.

Property Documentation

int OpenSim.Framework.PriorityQueue.Count
get

Return the number of items in the queues

Definition at line 102 of file PriorityQueue.cs.

object OpenSim.Framework.PriorityQueue.SyncRoot
get

Definition at line 78 of file PriorityQueue.cs.


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