gr.uoa.di.madgik.grs.proxy
Interface IReaderProxy

All Superinterfaces:
IProxy
All Known Implementing Classes:
HTTPReaderProxy, HTTPStoreReaderProxy, LocalReaderProxy, LocalStoreReaderProxy, TCPReaderProxy, TCPStoreReaderProxy

public interface IReaderProxy
extends IProxy

The IProxy specialization that needs to be implemented by the proxy implementations that are used by reader clients

Author:
gpapanikos

Nested Class Summary
 
Nested classes/interfaces inherited from interface gr.uoa.di.madgik.grs.proxy.IProxy
IProxy.ProxyType
 
Field Summary
 
Fields inherited from interface gr.uoa.di.madgik.grs.proxy.IProxy
ProxyScheme, ProxyStoreScheme
 
Method Summary
 void fromLocator(java.net.URI locator)
          Populates an instance of the IReaderProxy implementer with the information provided through the specific locator URI
 IBuffer getBuffer()
          After the proxy has been initialized, through this method, the IBuffer that can be used by the reader to access the writer side IBuffer can be retrieved
 void overrideBufferCapacity(int capacity)
          After the proxy has been initialized, this method can be used to provide a hint to the IReaderProxy to use a capacity different than that of the producer's buffer.
 

Method Detail

fromLocator

void fromLocator(java.net.URI locator)
                 throws GRS2ProxyException
Populates an instance of the IReaderProxy implementer with the information provided through the specific locator URI

Parameters:
locator -
Throws:
GRS2ProxyException - The proxy initialization could not be completed

overrideBufferCapacity

void overrideBufferCapacity(int capacity)
                            throws GRS2ProxyException
After the proxy has been initialized, this method can be used to provide a hint to the IReaderProxy to use a capacity different than that of the producer's buffer. Whether or not this hint is taken into account depends on the IReaderProxy implementation. For example, it is highly unlikely that it will be honored in cases when both the producer and the consumer run into the same address space.

Parameters:
capacity -
GRS2ProxyException - The capacity of the buffer cannot be overriden
Throws:
GRS2ProxyException

getBuffer

IBuffer getBuffer()
                  throws GRS2ProxyException
After the proxy has been initialized, through this method, the IBuffer that can be used by the reader to access the writer side IBuffer can be retrieved

Returns:
The IBuffer that is serving the reader
Throws:
GRS2ProxyException - the IBuffer could not be retrieved