9bb8decbcf
Former-commit-id:133dc97f67[formerlya02aeb236c] [formerly9f19e3f712] [formerly06a8b51d6d[formerly9f19e3f712[formerly 64fa9254b946eae7e61bbc3f513b7c3696c4f54f]]] Former-commit-id:06a8b51d6dFormer-commit-id:377dcd10b9[formerly3360eb6c5f] Former-commit-id:8e80217e59
95 lines
4 KiB
C#
95 lines
4 KiB
C#
/*
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one
|
|
* or more contributor license agreements. See the NOTICE file
|
|
* distributed with this work for additional information
|
|
* regarding copyright ownership. The ASF licenses this file
|
|
* to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
* KIND, either express or implied. See the License for the
|
|
* specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
*/
|
|
using System;
|
|
using System.Collections;
|
|
|
|
namespace Apache.Qpid.Collections
|
|
{
|
|
public abstract class BlockingQueue : Queue
|
|
{
|
|
/**
|
|
* Inserts the specified element into this queue if it is possible to do
|
|
* so immediately without violating capacity restrictions, returning
|
|
* <tt>true</tt> upon success and <tt>false</tt> if no space is currently
|
|
* available. When using a capacity-restricted queue, this method is
|
|
* generally preferable to {@link #add}, which can fail to insert an
|
|
* element only by throwing an exception.
|
|
*
|
|
* @param e the element to add
|
|
* @return <tt>true</tt> if the element was added to this queue, else
|
|
* <tt>false</tt>
|
|
* @throws ClassCastException if the class of the specified element
|
|
* prevents it from being added to this queue
|
|
* @throws NullPointerException if the specified element is null
|
|
* @throws IllegalArgumentException if some property of the specified
|
|
* element prevents it from being added to this queue
|
|
*/
|
|
public abstract bool EnqueueNoThrow(Object e);
|
|
|
|
/**
|
|
* Inserts the specified element into this queue, waiting if necessary
|
|
* for space to become available.
|
|
*
|
|
* @param e the element to add
|
|
* @throws InterruptedException if interrupted while waiting
|
|
* @throws ClassCastException if the class of the specified element
|
|
* prevents it from being added to this queue
|
|
* @throws NullPointerException if the specified element is null
|
|
* @throws IllegalArgumentException if some property of the specified
|
|
* element prevents it from being added to this queue
|
|
*/
|
|
public abstract void EnqueueBlocking(object e);
|
|
|
|
/**
|
|
* Retrieves and removes the head of this queue, waiting up to the
|
|
* specified wait time if necessary for an element to become available.
|
|
*
|
|
* @param timeout how long to wait before giving up, in units of
|
|
* <tt>unit</tt>
|
|
* @param unit a <tt>TimeUnit</tt> determining how to interpret the
|
|
* <tt>timeout</tt> parameter
|
|
* @return the head of this queue, or <tt>null</tt> if the
|
|
* specified waiting time elapses before an element is available
|
|
* @throws InterruptedException if interrupted while waiting
|
|
*/
|
|
public abstract object DequeueBlocking();
|
|
|
|
/**
|
|
* Returns the number of additional elements that this queue can ideally
|
|
* (in the absence of memory or resource constraints) accept without
|
|
* blocking, or <tt>Integer.MAX_VALUE</tt> if there is no intrinsic
|
|
* limit.
|
|
*
|
|
* <p>Note that you <em>cannot</em> always tell if an attempt to insert
|
|
* an element will succeed by inspecting <tt>remainingCapacity</tt>
|
|
* because it may be the case that another thread is about to
|
|
* insert or remove an element.
|
|
*
|
|
* @return the remaining capacity
|
|
*/
|
|
public abstract int RemainingCapacity
|
|
{
|
|
get;
|
|
}
|
|
}
|
|
}
|
|
|
|
|