A.18.27 The Generic Package Containers.Synchronized_Queue_Interfaces
{
AI05-0159-1}
The language-defined generic package Containers.Synchronized_Queue_Interfaces
provides interface type Queue, and a set of operations for that type.
Interface Queue specifies a first-in, first-out queue.
Static Semantics
{
AI05-0159-1}
The generic library package Containers.Synchronized_Queue_Interfaces
has the following declaration:
generic
type Element_Type
is private;
package Ada.Containers.Synchronized_Queue_Interfaces
is
pragma Pure(Synchronized_Queue_Interfaces);
type Queue
is synchronized interface;
procedure Enqueue
(Container :
in out Queue;
New_Item :
in Element_Type)
is abstract
with Synchronization => By_Entry;
procedure Dequeue
(Container :
in out Queue;
Element :
out Element_Type)
is abstract
with Synchronization => By_Entry;
function Current_Use (Container : Queue)
return Count_Type
is abstract;
function Peak_Use (Container : Queue)
return Count_Type
is abstract;
end Ada.Containers.Synchronized_Queue_Interfaces;
procedure Enqueue
(Container : in out Queue;
New_Item : in Element_Type) is abstract;
{
AI05-0159-1}
{
AI05-0262-1}
{
AI05-0264-1}
A queue type that implements this interface is allowed to have a bounded
capacity. If the queue object has a bounded
capacity, and the number of existing elements equals the capacity, then
Enqueue blocks until storage becomes available; otherwise, Enqueue does
not block. In any case, it then copies New_Item onto the queue.
procedure Dequeue
(Container : in out Queue;
Element : out Element_Type) is abstract;
{
AI05-0159-1}
{
AI05-0251-1}
If the queue is empty, then Dequeue blocks until an item becomes available.
In any case, it then assigns the element at the head of the queue to
Element, and removes it from the queue.
function Current_Use (Container : Queue) return Count_Type is abstract;
{
AI05-0159-1}
Returns the number of elements currently in the queue.
function Peak_Use (Container : Queue) return Count_Type is abstract;
{
AI05-0159-1}
Returns the maximum number of elements that have been in the queue at
any one time.
51 {
AI05-0251-1}
Unlike other language-defined containers, there are no queues whose element
types are indefinite. Elements of an indefinite type can be handled by
defining the element of the queue to be a holder container (see
A.18.18)
of the indefinite type, or to be an explicit access type that designates
the indefinite type.
Reason: There are no indefinite queues,
as a useful definition for Dequeue is not possible. Dequeue cannot be
a function, as Ada does not have entries that are functions (thus conditional
and timed calls would not be possible). Moreover, protected functions
do not allow modifying the queue object (thus it doesn't work even if
we decided we didn't care about conditional and timed calls). If Dequeue
is an entry, then the dequeued object would have to be an out
parameter and that would require the queue client to guess the tag and
constraints of the value that will be dequeued (otherwise Constraint_Error
would be raised), and that is rarely going to be possible.
Extensions to Ada 2005
Ada 2005 and 2012 Editions sponsored in part by Ada-Europe
