@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)

Package de.schlichtherle.truezip.socket

Provides I/O sockets to address and resolve targets for I/O operations.

See: Description

Interface Summary

Interface	Description
InputEntry<E extends InputEntry<E>>	An entry which provides input sockets.
InputService<E extends Entry>	A service for input sockets.
InputShop<E extends Entry>	A closable input service.
IOEntry<E extends IOEntry<E>>	An entry which provides I/O sockets.
IOPool<E extends IOEntry<E>>	A pool for allocating I/O buffers, which are used as a volatile storage for bulk data.
IOPool.Entry<E extends IOEntry<E>>	A releasable I/O buffer.
IOPoolProvider	A provider for an I/O buffer pool.
OutputEntry<E extends OutputEntry<E>>	An entry which provides output sockets.
OutputService<E extends Entry>	A service for output sockets.
OutputShop<E extends Entry>	A closable output service.

Class Summary

Class	Description
ClutchInputSocket<E extends Entry>	An input socket which obtains its delegate lazily and ClutchInputSocket.reset()s it upon any Throwable.
ClutchOutputSocket<E extends Entry>	An output socket which obtains its delegate lazily and ClutchOutputSocket.reset()s it upon any Throwable.
DecoratingInputShop<E extends Entry,I extends InputShop<E>>	An abstract decorator for an input shop.
DecoratingInputSocket<E extends Entry>	An abstract decorator for an input socket.
DecoratingOutputShop<E extends Entry,O extends OutputShop<E>>	An abstract decorator for an output shop.
DecoratingOutputSocket<E extends Entry>	An abstract decorator for an output socket.
DelegatingInputSocket<E extends Entry>	Delegates all methods to another input socket.
DelegatingOutputSocket<E extends Entry>	Delegates all methods to another output socket.
DisconnectingInputShop<E extends Entry>	Decorates another input shop in order to disconnect any resources when this input shop gets closed.
DisconnectingOutputShop<E extends Entry>	Decorates another output shop in order to disconnect any resources when this output shop gets closed.
InputSocket<E extends Entry>	An abstract factory for input resources for reading bytes from its local target.
IOCache	Provides caching services for input and output sockets with the following features: Upon the first read operation, the entry data will be read from the backing store and stored in the cache.
IOSocket<LT,PT>	An abstract class for objects to do some I/O on a local target.
LockInputShop<E extends Entry>	Decorates another input shop to allow concurrent access which is synchronized by a Lock object provided to its constructor.
LockOutputShop<E extends Entry>	Decorates another output shop to allow concurrent access which is synchronized by a Lock object provided to its constructor.
MultiplexedOutputShop<E extends MutableEntry>	Decorates annother output shop to support a virtually unlimited number of entries which may be written concurrently while actually at most one entry is written concurrently to the decorated output shop.
OutputSocket<E extends Entry>	An abstract factory for output resources for writing bytes to its local target.

Enum Summary

Enum	Description
IOCache.Strategy	Provides different cache strategies.

Package de.schlichtherle.truezip.socket Description

Provides I/O sockets to address and resolve targets for I/O operations. Similar to network sockets, I/O sockets are a very powerful concept: They support input, output, copying, caching, proxying etc. of the contents of a generic local target and an optional peer target. By using I/O sockets, you'll never have to write a fast copy routine again.

In order to maximize the versatility of I/O sockets, it's highly recommended for any implementation that it performs any I/O initialization lazily. That is, creating a socket should never throw a IOException. If initializing I/O is required, it should be done in any of the methods provided by the socket instead.

Author:

Christian Schlichtherle