net.sf.sshapi

Class AbstractSocket

java.lang.Object

java.net.Socket

net.sf.sshapi.AbstractSocket

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public abstract class AbstractSocket
extends java.net.Socket

Abstract implementation of a Socket, used by the Tunneled Sockets feature of SSHAPI and it's providers.

Constructor Summary

Constructors

Constructor and Description
AbstractSocket() Constructor
AbstractSocket(java.net.InetAddress host, int port) Constructor.
AbstractSocket(java.lang.String host, int port) Constructor.

Method Summary

Modifier and Type	Method and Description
void	bind(java.net.SocketAddress bindpoint)
void	close()
void	connect(java.net.SocketAddress endpoint, int timeout)
protected abstract void	doClose()
java.nio.channels.SocketChannel	getChannel()
java.net.InetAddress	getInetAddress()
boolean	getKeepAlive()
boolean	getOOBInline()
int	getPort()
int	getReceiveBufferSize()
boolean	getReuseAddress()
int	getSendBufferSize()
int	getSoLinger()
int	getSoTimeout()
boolean	getTcpNoDelay()
int	getTrafficClass()
boolean	isBound()
boolean	isClosed()
boolean	isInputShutdown()
boolean	isOutputShutdown()
protected abstract void	onConnect(java.net.InetSocketAddress endpoint, int timeout)
void	sendUrgentData(int data)
void	setKeepAlive(boolean on)
void	setOOBInline(boolean on)
void	setPerformancePreferences(int connectionTime, int latency, int bandwidth)
void	setReceiveBufferSize(int size)
void	setReuseAddress(boolean on)
void	setSendBufferSize(int size)
void	setSoLinger(boolean on, int linger)
void	setSoTimeout(int timeout)
void	setTcpNoDelay(boolean on)
void	setTrafficClass(int tc)
void	shutdownInput()
void	shutdownOutput()
java.lang.String	toString()

Methods inherited from class java.net.Socket

connect, getInputStream, getLocalAddress, getLocalPort, getLocalSocketAddress, getOutputStream, getRemoteSocketAddress, isConnected, setSocketImplFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractSocket

public AbstractSocket()

Constructor

AbstractSocket

public AbstractSocket(java.lang.String host,
                      int port)
               throws java.net.UnknownHostException,
                      java.io.IOException

Constructor.

Parameters:

host - host

port - port

Throws:

java.net.UnknownHostException

java.io.IOException

AbstractSocket

public AbstractSocket(java.net.InetAddress host,
                      int port)
               throws java.net.UnknownHostException,
                      java.io.IOException

Constructor.

Parameters:

host - host

port - port

Throws:

java.net.UnknownHostException

java.io.IOException

Method Detail

bind

public void bind(java.net.SocketAddress bindpoint)
          throws java.io.IOException

Overrides:

bind in class java.net.Socket

Throws:

java.io.IOException

connect

public final void connect(java.net.SocketAddress endpoint,
                          int timeout)
                   throws java.io.IOException

Overrides:

connect in class java.net.Socket

Throws:

java.io.IOException

onConnect

protected abstract void onConnect(java.net.InetSocketAddress endpoint,
                                  int timeout)
                           throws java.io.IOException

Throws:

java.io.IOException

close

public final void close()
                 throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.net.Socket

Throws:

java.io.IOException

doClose

protected abstract void doClose()
                         throws java.io.IOException

Throws:

java.io.IOException

isBound

public boolean isBound()

Overrides:

isBound in class java.net.Socket

isClosed

public boolean isClosed()

Overrides:

isClosed in class java.net.Socket

isInputShutdown

public boolean isInputShutdown()

Overrides:

isInputShutdown in class java.net.Socket

isOutputShutdown

public boolean isOutputShutdown()

Overrides:

isOutputShutdown in class java.net.Socket

sendUrgentData

public void sendUrgentData(int data)
                    throws java.io.IOException

Overrides:

sendUrgentData in class java.net.Socket

Throws:

java.io.IOException

setKeepAlive

public void setKeepAlive(boolean on)
                  throws java.net.SocketException

Overrides:

setKeepAlive in class java.net.Socket

Throws:

java.net.SocketException

setOOBInline

public void setOOBInline(boolean on)
                  throws java.net.SocketException

Overrides:

setOOBInline in class java.net.Socket

Throws:

java.net.SocketException

setPerformancePreferences

public void setPerformancePreferences(int connectionTime,
                                      int latency,
                                      int bandwidth)

Overrides:

setPerformancePreferences in class java.net.Socket

setReceiveBufferSize

public void setReceiveBufferSize(int size)
                          throws java.net.SocketException

Overrides:

setReceiveBufferSize in class java.net.Socket

Throws:

java.net.SocketException

setReuseAddress

public void setReuseAddress(boolean on)
                     throws java.net.SocketException

Overrides:

setReuseAddress in class java.net.Socket

Throws:

java.net.SocketException

setSendBufferSize

public void setSendBufferSize(int size)
                       throws java.net.SocketException

Overrides:

setSendBufferSize in class java.net.Socket

Throws:

java.net.SocketException

setSoLinger

public void setSoLinger(boolean on,
                        int linger)
                 throws java.net.SocketException

Overrides:

setSoLinger in class java.net.Socket

Throws:

java.net.SocketException

setSoTimeout

public void setSoTimeout(int timeout)
                  throws java.net.SocketException

Overrides:

setSoTimeout in class java.net.Socket

Throws:

java.net.SocketException

setTcpNoDelay

public void setTcpNoDelay(boolean on)
                   throws java.net.SocketException

Overrides:

setTcpNoDelay in class java.net.Socket

Throws:

java.net.SocketException

setTrafficClass

public void setTrafficClass(int tc)
                     throws java.net.SocketException

Overrides:

setTrafficClass in class java.net.Socket

Throws:

java.net.SocketException

shutdownInput

public void shutdownInput()
                   throws java.io.IOException

Overrides:

shutdownInput in class java.net.Socket

Throws:

java.io.IOException

shutdownOutput

public void shutdownOutput()
                    throws java.io.IOException

Overrides:

shutdownOutput in class java.net.Socket

Throws:

java.io.IOException

getChannel

public java.nio.channels.SocketChannel getChannel()

Overrides:

getChannel in class java.net.Socket

getInetAddress

public java.net.InetAddress getInetAddress()

Overrides:

getInetAddress in class java.net.Socket

getKeepAlive

public boolean getKeepAlive()
                     throws java.net.SocketException

Overrides:

getKeepAlive in class java.net.Socket

Throws:

java.net.SocketException

getOOBInline

public boolean getOOBInline()
                     throws java.net.SocketException

Overrides:

getOOBInline in class java.net.Socket

Throws:

java.net.SocketException

getPort

public int getPort()

Overrides:

getPort in class java.net.Socket

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws java.net.SocketException

Overrides:

getReceiveBufferSize in class java.net.Socket

Throws:

java.net.SocketException

getReuseAddress

public boolean getReuseAddress()
                        throws java.net.SocketException

Overrides:

getReuseAddress in class java.net.Socket

Throws:

java.net.SocketException

getSendBufferSize

public int getSendBufferSize()
                      throws java.net.SocketException

Overrides:

getSendBufferSize in class java.net.Socket

Throws:

java.net.SocketException

getSoLinger

public int getSoLinger()
                throws java.net.SocketException

Overrides:

getSoLinger in class java.net.Socket

Throws:

java.net.SocketException

getSoTimeout

public int getSoTimeout()
                 throws java.net.SocketException

Overrides:

getSoTimeout in class java.net.Socket

Throws:

java.net.SocketException

getTcpNoDelay

public boolean getTcpNoDelay()
                      throws java.net.SocketException

Overrides:

getTcpNoDelay in class java.net.Socket

Throws:

java.net.SocketException

getTrafficClass

public int getTrafficClass()
                    throws java.net.SocketException

Overrides:

getTrafficClass in class java.net.Socket

Throws:

java.net.SocketException

toString

public java.lang.String toString()

Overrides:

toString in class java.net.Socket