UnixSocket

java.lang.Object
- java.net.Socket
- - jnr.unixsocket.UnixSocket

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public class UnixSocket
extends java.net.Socket
```

Field Summary

Fields
Modifier and Type	Field and Description
`private UnixSocketChannel`	`chan`
`private java.util.concurrent.atomic.AtomicBoolean`	`closed`
`private java.io.InputStream`	`in`
`private java.util.concurrent.atomic.AtomicBoolean`	`indown`
`private java.io.OutputStream`	`out`
`private java.util.concurrent.atomic.AtomicBoolean`	`outdown`

Constructor Summary

Constructors
Constructor and Description

UnixSocket(UnixSocketChannel chan)

Constructors
Constructor and Description
`UnixSocket(UnixSocketChannel chan)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bind(java.net.SocketAddress local)`
`void`	`close()`
`void`	`connect(java.net.SocketAddress addr)`
`void`	`connect(java.net.SocketAddress addr, java.lang.Integer timeout)`
`java.nio.channels.SocketChannel`	`getChannel()`
`Credentials`	`getCredentials()` Retrieves the credentials for this UNIX socket.
`java.net.InetAddress`	`getInetAddress()`
`java.io.InputStream`	`getInputStream()`
`boolean`	`getKeepAlive()`
`java.net.SocketAddress`	`getLocalSocketAddress()`
`java.io.OutputStream`	`getOutputStream()`
`int`	`getReceiveBufferSize()`
`java.net.SocketAddress`	`getRemoteSocketAddress()`
`int`	`getSendBufferSize()`
`int`	`getSoTimeout()`
`private void`	`ignore()`
`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
connect, getLocalAddress, getLocalPort, getOOBInline, getPort, getReuseAddress, getSoLinger, getTcpNoDelay, getTrafficClass, sendUrgentData, setOOBInline, setPerformancePreferences, setReuseAddress, setSocketImplFactory, setSoLinger, setTcpNoDelay, setTrafficClass, toString

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

- Field Detail
  - chan
```
private UnixSocketChannel chan
```
  - closed
```
private java.util.concurrent.atomic.AtomicBoolean closed
```
  - indown
```
private java.util.concurrent.atomic.AtomicBoolean indown
```
  - outdown
```
private java.util.concurrent.atomic.AtomicBoolean outdown
```
  - in
```
private java.io.InputStream in
```
  - out
```
private java.io.OutputStream out
```
- Constructor Detail
  - UnixSocket
```
public UnixSocket(UnixSocketChannel chan)
```
- Method Detail
  - bind
```
public void bind(java.net.SocketAddress local)
          throws java.io.IOException
```
    Overrides:
    
    bind in class java.net.Socket
    
    Throws:
    
    java.io.IOException
  - close
```
public 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
  - connect
```
public void connect(java.net.SocketAddress addr)
             throws java.io.IOException
```
    Overrides:
    
    connect in class java.net.Socket
    
    Throws:
    
    java.io.IOException
  - connect
```
public void connect(java.net.SocketAddress addr,
                    java.lang.Integer timeout)
             throws java.io.IOException
```
    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
  - getInputStream
```
public java.io.InputStream getInputStream()
                                   throws java.io.IOException
```
    Overrides:
    
    getInputStream in class java.net.Socket
    
    Throws:
    
    java.io.IOException
  - getLocalSocketAddress
```
public java.net.SocketAddress getLocalSocketAddress()
```
    Overrides:
    
    getLocalSocketAddress in class java.net.Socket
  - getOutputStream
```
public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException
```
    Overrides:
    
    getOutputStream in class java.net.Socket
    
    Throws:
    
    java.io.IOException
  - getRemoteSocketAddress
```
public java.net.SocketAddress getRemoteSocketAddress()
```
    Overrides:
    
    getRemoteSocketAddress in class java.net.Socket
  - isBound
```
public boolean isBound()
```
    Overrides:
    
    isBound in class java.net.Socket
  - isClosed
```
public boolean isClosed()
```
    Overrides:
    
    isClosed in class java.net.Socket
  - isConnected
```
public boolean isConnected()
```
    Overrides:
    
    isConnected 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
  - 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
  - getCredentials
```
public final Credentials getCredentials()
                                 throws java.net.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:
    
    java.lang.UnsupportedOperationException - if the underlying socket library doesn't support the SO_PEERCRED option
    
    java.net.SocketException - if fetching the socket option failed.
  - getKeepAlive
```
public boolean getKeepAlive()
                     throws java.net.SocketException
```
    Overrides:
    
    getKeepAlive in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
                         throws java.net.SocketException
```
    Overrides:
    
    getReceiveBufferSize 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
  - getSoTimeout
```
public int getSoTimeout()
                 throws java.net.SocketException
```
    Overrides:
    
    getSoTimeout in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - setKeepAlive
```
public void setKeepAlive(boolean on)
                  throws java.net.SocketException
```
    Overrides:
    
    setKeepAlive in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - setReceiveBufferSize
```
public void setReceiveBufferSize(int size)
                          throws java.net.SocketException
```
    Overrides:
    
    setReceiveBufferSize 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
  - setSoTimeout
```
public void setSoTimeout(int timeout)
                  throws java.net.SocketException
```
    Overrides:
    
    setSoTimeout in class java.net.Socket
    
    Throws:
    
    java.net.SocketException
  - ignore
```
private void ignore()
```

Class UnixSocket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.net.Socket

Methods inherited from class java.lang.Object

Field Detail

chan

closed

indown

outdown

in

out

Constructor Detail

UnixSocket

Method Detail

bind

close

connect

connect

getChannel

getInetAddress

getInputStream

getLocalSocketAddress

getOutputStream

getRemoteSocketAddress

isBound

isClosed

isConnected

isInputShutdown

isOutputShutdown

shutdownInput

shutdownOutput

getCredentials

getKeepAlive

getReceiveBufferSize

getSendBufferSize

getSoTimeout

setKeepAlive

setReceiveBufferSize

setSendBufferSize

setSoTimeout

ignore