IOSocket (TrueZIP Kernel 7.2-rc-2 API)

java.lang.Object
- de.schlichtherle.truezip.socket.IOSocket<LT,PT>

Type Parameters:
LT - the type of the local target for I/O operations.
PT - the type of the peer target for I/O operations.

Direct Known Subclasses:

InputSocket, OutputSocket
```
@ThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public abstract class IOSocket<LT,PT>
extends java.lang.Object
```
An abstract factory for objects to do some I/O on a local target. I/O sockets can be used to copy data easily and very fast. When copying data, the local target gets connected to a peer target. Once connected, the sockets can then setup the data to be transferred by the copy method. This feature enables to avoid data recompression when copying a compressed archive entry to another archive entry of the same type.

Author:

Christian Schlichtherle

Constructor Summary

Constructors
Constructor and Description

IOSocket()
You cannot instantiate this class outside its package.

Constructors
Constructor and Description
`IOSocket()` You cannot instantiate this class outside its package.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`copy(InputSocket<?> input, OutputSocket<?> output)` Copies an input stream `created` by the given input socket `input` to an output stream `created` by the given output socket `output`.
`boolean`	`equals(java.lang.Object that)` Two sockets are considered equal if and only if they are identical.
`abstract LT`	`getLocalTarget()` Returns the local target for I/O operations.
`abstract PT`	`getPeerTarget()` Returns the peer target for I/O operations.
`int`	`hashCode()` Returns a hash code which is consistent with `equals(java.lang.Object)`.
`java.lang.String`	`toString()` Returns a string representing a connection of the local and peer targets.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IOSocket
```
IOSocket()
```
    You cannot instantiate this class outside its package.
- Method Detail
  - getLocalTarget
```
public abstract LT getLocalTarget()
                           throws java.io.IOException
```
    Returns the local target for I/O operations.
    Note that this interface contract does not state any other terms or conditions for the returned object. In particular, clients need to consider that multiple invocations of this method could return different objects (e.g. defensive copies) which may even fail the Object.equals(java.lang.Object) test. On the other hand, implementations need to consider that clients could attempt to change the state of the returned object in arbitrary manner. Consequently, the result of doing so is undefined, too. In particular, a subsequent I/O operation may not reflect the change or may even fail. Sub-interfaces or implementations may add additional terms and conditions in order to resolve these potential issues.
    
    Returns:
    The local target for I/O operations.
    
    Throws:
    
    java.io.IOException
  - getPeerTarget
```
@CheckForNull
public abstract PT getPeerTarget()
                          throws java.io.IOException
```
    Returns the peer target for I/O operations.
    The same considerations as for getLocalTarget() apply here, too.
    
    Returns:
    The peer target for I/O operations.
    
    Throws:
    
    java.io.IOException
  - copy
```
public static void copy(InputSocket<?> input,
        OutputSocket<?> output)
                 throws java.io.IOException
```
    Copies an input stream created by the given input socket input to an output stream created by the given output socket output.
    This is a high performance implementation which uses a pooled background thread to fill a FIFO of pooled buffers which is concurrently flushed by the current thread.
    
    Parameters:
    input - an input socket for the input target.
    output - an output socket for the output target.
    
    Throws:
    
    InputException - if copying the data fails because of an IOException thrown by the input stream.
    
    java.io.IOException - if copying the data fails because of an IOException thrown by the output stream.
  - toString
```
public java.lang.String toString()
```
    Returns a string representing a connection of the local and peer targets.
    
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public final boolean equals(@CheckForNull
             java.lang.Object that)
```
    Two sockets are considered equal if and only if they are identical. This can't get overriden.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public final int hashCode()
```
    Returns a hash code which is consistent with equals(java.lang.Object). This can't get overriden.
    
    Overrides:
    
    hashCode in class java.lang.Object

Class IOSocket<LT,PT>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IOSocket

Method Detail

getLocalTarget

getPeerTarget

copy

toString

equals

hashCode