class UpdateQueue Update Queue for RIP Route entries. More... Definition #include <update_queue.hh> Template form UpdateQueue<typename A> List of all Methods

Annotated List Files Globals Hierarchy Index

Public Types

• typedef ref_ptr<Reader> ReadIterator
• typedef RouteEntryRef<A> RouteUpdate

Public Methods

•  UpdateQueue ()
•  ~UpdateQueue ()
• void  push_back (const RouteUpdate& ru)
• void  flush ()
• ReadIterator  create_reader ()
• void  destroy_reader (ReadIterator& r)
• const RouteEntry<A>*  next (ReadIterator& r)
• const RouteEntry<A>*  get (ReadIterator& r) const
• void  ffwd (ReadIterator& r)
• void  rwd (ReadIterator& r)
• uint32_t  updates_queued () const

Protected Types

• typedef UpdateQueueReader<A> Reader

Protected Members

• UpdateQueueImpl<A>* _impl

Detailed Description

The Update Queue has is conceptually a single writer multi-reader queue. It is used to store state for triggered updates and may be used unsolicited responses (routing table announcements).

[protected]

Add update to back of queue.

Remove all queued entries and reset all read iterators to the front of the queue.

Create a read iterator. These are reference counted entities that need to be stored in order to operate. The newly created reader is set to the end of the update queue.

Destroy read iterator. This method detaches the iterator from the update queue. Use of the iterator after this call is unsafe.

Increment iterator and return pointer to entry if available.

Returns: A pointer to a RouteEntry if available, 0 otherwise.

[const]

Get the RouteEntry associated with the read iterator.

Returns: A pointer to a RouteEntry if available, 0 otherwise.

Advance read iterator to end of update queue. Calls to next and get will return 0 until further updates occur.

Move read iterator to first entry of update queue.

[const]

Return number of updates held. Note: this may be more than are available for reading since there is internal buffering and UpdateQueue iterators attach at the end of the UpdateQueue.

Returns: number of updates queued.

[protected]