Sharpility
Public Member Functions | Properties
Sharpility.Collections.IQueue< T > Interface Template Reference

A collection designed for holding elements prior to processing. More...

Inheritance diagram for Sharpility.Collections.IQueue< T >:
Sharpility.Collections.Concurrent.BlockingQueue< T > Sharpility.Collections.Concurrent.DefaultConcurrentQueue< T > Sharpility.Collections.DefaultQueue< T > Sharpility.Collections.LinkedQueue< T > Sharpility.Collections.MappedQueue< T > Sharpility.Collections.Concurrent.DefaultBlockingQueue< T > Sharpility.Collections.SortedMappedQueue< T > Sharpility.Collections.AbstractSortedMappedQueue< TKey, TValue, TQ >

List of all members.

Public Member Functions

bool Offer (T item)
 Offers item to queue.
T Peek ()
 Returns first item in queue.
T Poll ()
 Removes and return first item in queue.
void Clear ()
 Clears queue.
bool Contains (T item)
 Checks is queue contains item.

Properties

int Count [get]
 Returns number of queue items.

Detailed Description

template<T>
interface Sharpility::Collections::IQueue< T >

A collection designed for holding elements prior to processing.

Template Parameters:
T

Member Function Documentation

template<T >
void Sharpility.Collections.IQueue< T >.Clear ( )

Clears queue.

Implemented in Sharpility.Collections.Concurrent.DefaultBlockingQueue< T >, Sharpility.Collections.AbstractSortedMappedQueue< TKey, TValue, TQ >, Sharpility.Collections.DefaultQueue< T >, Sharpility.Collections.Concurrent.DefaultConcurrentQueue< T >, and Sharpility.Collections.LinkedQueue< T >.

template<T >
bool Sharpility.Collections.IQueue< T >.Contains ( T  item)

Checks is queue contains item.

Parameters:
itemcheckd item
Returns:
is queue contains item

Implemented in Sharpility.Collections.Concurrent.DefaultBlockingQueue< T >, Sharpility.Collections.Concurrent.DefaultConcurrentQueue< T >, Sharpility.Collections.DefaultQueue< T >, and Sharpility.Collections.LinkedQueue< T >.

template<T >
bool Sharpility.Collections.IQueue< T >.Offer ( T  item)

Offers item to queue.

Parameters:
itemoffered item
Returns:
true if item was accepted

Implemented in Sharpility.Collections.Concurrent.DefaultBlockingQueue< T >, Sharpility.Collections.DefaultQueue< T >, Sharpility.Collections.Concurrent.DefaultConcurrentQueue< T >, and Sharpility.Collections.LinkedQueue< T >.

template<T >
T Sharpility.Collections.IQueue< T >.Peek ( )

Returns first item in queue.

Returns:
first item in queue

Implemented in Sharpility.Collections.Concurrent.DefaultBlockingQueue< T >, Sharpility.Collections.AbstractSortedMappedQueue< TKey, TValue, TQ >, Sharpility.Collections.DefaultQueue< T >, Sharpility.Collections.Concurrent.DefaultConcurrentQueue< T >, and Sharpility.Collections.LinkedQueue< T >.

template<T >
T Sharpility.Collections.IQueue< T >.Poll ( )

Removes and return first item in queue.

Returns:
Removed first queue item

Implemented in Sharpility.Collections.Concurrent.DefaultBlockingQueue< T >, Sharpility.Collections.AbstractSortedMappedQueue< TKey, TValue, TQ >, Sharpility.Collections.DefaultQueue< T >, Sharpility.Collections.Concurrent.DefaultConcurrentQueue< T >, and Sharpility.Collections.LinkedQueue< T >.

Property Documentation

template<T >
int Sharpility.Collections.IQueue< T >.Count [get]

Returns number of queue items.

Implemented in Sharpility.Collections.Concurrent.DefaultBlockingQueue< T >, Sharpility.Collections.AbstractSortedMappedQueue< TKey, TValue, TQ >, Sharpility.Collections.Concurrent.DefaultConcurrentQueue< T >, Sharpility.Collections.DefaultQueue< T >, and Sharpility.Collections.LinkedQueue< T >.

The documentation for this interface was generated from the following file:
 All Classes Namespaces Functions Enumerations Properties