info.pppc.base.plugin.ip.util

Class IPStreamConnector

java.lang.Object

info.pppc.base.plugin.ip.util.IPStreamConnector

All Implemented Interfaces:

IConnector, IStreamConnector

public class IPStreamConnector
extends java.lang.Object
implements IStreamConnector

The stream connector transforms an incoming or outgoing socket into a stream connector that can be used by base. The stream connector uses the connector vector to maintain references to all opened connectors. If a connector is closed, it is automatically removed from the vector.

Author:

Marcus Handte

Constructor Summary

Constructors

Constructor and Description
IPStreamConnector(IIPPlugin plugin, java.net.Socket socket) Creates a new stream connector that uses the specified socket to communicate and adds the new stream connector to the connector list.

Method Summary

Methods

Modifier and Type	Method and Description
java.io.InputStream	getInputStream() Returns the input stream of the socket.
java.io.OutputStream	getOutputStream() Returns the output stream of the socket.
IPlugin	getPlugin() Returns a reference to the underlying plug-in.
void	release() Closes the socket bound to the connector, thereby canceling the input and output streams.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IPStreamConnector

public IPStreamConnector(IIPPlugin plugin,
                 java.net.Socket socket)

Creates a new stream connector that uses the specified socket to communicate and adds the new stream connector to the connector list.

Parameters:

socket - The socket of the connector.

plugin - The responsible plug-in.

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Returns the input stream of the socket. The input stream is cached so that it is not retrieved multiple times.

Specified by:

getInputStream in interface IStreamConnector

Returns:

The input stream of the socket. The input stream is only retrieved at most once per stream connector.

Throws:

java.io.IOException - Thrown if the stream cannot be opened.

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Returns the output stream of the socket. The output stream is cached so that it is not retrieved multiple times.

Specified by:

getOutputStream in interface IStreamConnector

Returns:

The output stream of the socket. The output stream is only retrieved at most once per stream connector.

Throws:

java.io.IOException - Thrown if the stream cannot be opened.

release

public void release()

Closes the socket bound to the connector, thereby canceling the input and output streams.

Specified by:

release in interface IConnector

getPlugin

public IPlugin getPlugin()

Returns a reference to the underlying plug-in.

Specified by:

getPlugin in interface IConnector

Returns:

A reference to the underlying plug-in.