Module org.jnrproject.unixsocket

Package jnr.unixsocket

Class UnixSocket

java.lang.Object

java.net.Socket

jnr.unixsocket.UnixSocket

All Implemented Interfaces:

Closeable, AutoCloseable

public class UnixSocket
extends Socket

Constructor Summary

Constructors

Constructor	Description
UnixSocket(UnixSocketChannel chan)

Method Summary

Modifier and Type	Method	Description
void	bind(SocketAddress local)
void	close()
void	connect(SocketAddress addr)
void	connect(SocketAddress addr, int timeout)
SocketChannel	getChannel()
Credentials	getCredentials()	Retrieves the credentials for this UNIX socket.
InetAddress	getInetAddress()
InputStream	getInputStream()
boolean	getKeepAlive()
SocketAddress	getLocalSocketAddress()
OutputStream	getOutputStream()
int	getReceiveBufferSize()
SocketAddress	getRemoteSocketAddress()
int	getSendBufferSize()
int	getSoTimeout()
boolean	isBound()
boolean	isClosed()
boolean	isConnected()
boolean	isInputShutdown()
boolean	isOutputShutdown()
void	setKeepAlive(boolean on)
void	setReceiveBufferSize(int size)
void	setSendBufferSize(int size)
void	setSoTimeout(int timeout)
void	shutdownInput()
void	shutdownOutput()

Methods inherited from class java.net.Socket

getLocalAddress, getLocalPort, getOOBInline, getOption, getPort, getReuseAddress, getSoLinger, getTcpNoDelay, getTrafficClass, sendUrgentData, setOOBInline, setOption, setPerformancePreferences, setReuseAddress, setSocketImplFactory, setSoLinger, setTcpNoDelay, setTrafficClass, supportedOptions, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UnixSocket

public UnixSocket(UnixSocketChannel chan)

Method Detail

bind

public void bind(SocketAddress local)
          throws IOException

Overrides:

bind in class Socket

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class Socket

Throws:

IOException

connect

public void connect(SocketAddress addr)
             throws IOException

Overrides:

connect in class Socket

Throws:

IOException

connect

public void connect(SocketAddress addr,
                    int timeout)
             throws IOException

Overrides:

connect in class Socket

Throws:

IOException

getChannel

public SocketChannel getChannel()

Overrides:

getChannel in class Socket

getInetAddress

public InetAddress getInetAddress()

Overrides:

getInetAddress in class Socket

getInputStream

public InputStream getInputStream()
                           throws IOException

Overrides:

getInputStream in class Socket

Throws:

IOException

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Overrides:

getLocalSocketAddress in class Socket

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Overrides:

getOutputStream in class Socket

Throws:

IOException

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Overrides:

getRemoteSocketAddress in class Socket

isBound

public boolean isBound()

Overrides:

isBound in class Socket

isClosed

public boolean isClosed()

Overrides:

isClosed in class Socket

isConnected

public boolean isConnected()

Overrides:

isConnected in class Socket

isInputShutdown

public boolean isInputShutdown()

Overrides:

isInputShutdown in class Socket

isOutputShutdown

public boolean isOutputShutdown()

Overrides:

isOutputShutdown in class Socket

shutdownInput

public void shutdownInput()
                   throws IOException

Overrides:

shutdownInput in class Socket

Throws:

IOException

shutdownOutput

public void shutdownOutput()
                    throws IOException

Overrides:

shutdownOutput in class Socket

Throws:

IOException

getCredentials

public final Credentials getCredentials()
                                 throws SocketException

Retrieves the credentials for this UNIX socket. Clients calling this method will receive the server's credentials, and servers will receive the client's credentials. User ID, group ID, and PID are supplied. See man unix 7; SCM_CREDENTIALS

Returns:

the credentials of the remote; null if not connected

Throws:

UnsupportedOperationException - if the underlying socket library doesn't support the SO_PEERCRED option

SocketException - if fetching the socket option failed.

getKeepAlive

public boolean getKeepAlive()
                     throws SocketException

Overrides:

getKeepAlive in class Socket

Throws:

SocketException

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws SocketException

Overrides:

getReceiveBufferSize in class Socket

Throws:

SocketException

getSendBufferSize

public int getSendBufferSize()
                      throws SocketException

Overrides:

getSendBufferSize in class Socket

Throws:

SocketException

getSoTimeout

public int getSoTimeout()
                 throws SocketException

Overrides:

getSoTimeout in class Socket

Throws:

SocketException

setKeepAlive

public void setKeepAlive(boolean on)
                  throws SocketException

Overrides:

setKeepAlive in class Socket

Throws:

SocketException

setReceiveBufferSize

public void setReceiveBufferSize(int size)
                          throws SocketException

Overrides:

setReceiveBufferSize in class Socket

Throws:

SocketException

setSendBufferSize

public void setSendBufferSize(int size)
                       throws SocketException

Overrides:

setSendBufferSize in class Socket

Throws:

SocketException

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException

Overrides:

setSoTimeout in class Socket

Throws:

SocketException