blob: f0d8b64ceb983a58ea51db12273a49331baadb6e (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
/***************************************************************************
* Copyright (c) 2004 - 2008 Eike Stepper, Germany.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Eike Stepper - initial API and implementation
**************************************************************************/
package org.eclipse.net4j;
/**
* Provides clients with the ability to obtain and retain {@link IBuffer}s.
*
* @author Eike Stepper
*/
public interface IBufferProvider
{
/**
* Returns the capacity of the buffers provided by {@link #provideBuffer()} .
*/
public short getBufferCapacity();
/**
* Provides a buffer from this <code>BufferProvider</code>.
*/
public IBuffer provideBuffer();
/**
* Retains a buffer to this <code>BufferProvider</code>.
*/
public void retainBuffer(IBuffer buffer);
/**
* Offers additional introspection features for {@link IBufferProvider}s.
*
* @author Eike Stepper
*/
public interface Introspection extends IBufferProvider
{
/**
* Returns the number of buffers that have already been provided by this <code>BufferProvider</code>.
*/
public long getProvidedBuffers();
/**
* Returns the number of buffers that have already been retained to this <code>BufferProvider</code>.
*/
public long getRetainedBuffers();
}
}
|