jnr.unixsocket

Class UnixSocketChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

jnr.enxio.channels.NativeSocketChannel

jnr.unixsocket.UnixSocketChannel

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, InterruptibleChannel, ReadableByteChannel, WritableByteChannel, jnr.enxio.channels.NativeSelectableChannel

public class UnixSocketChannel
extends jnr.enxio.channels.NativeSocketChannel

A Channel implementation that uses a native unix socket

Method Summary

Methods

Modifier and Type	Method and Description
boolean	connect(UnixSocketAddress remote)
boolean	finishConnect()
static UnixSocketChannel	fromFD(int fd) Create a UnixSocketChannel to wrap an existing file descriptor (presumably itself a UNIX socket).
static UnixSocketChannel	fromFD(int fd, int ops) Create a UnixSocketChannel to wrap an existing file descriptor (presumably itself a UNIX socket).
Credentials	getCredentials() Retrieves the credentials for this UNIX socket.
boolean	getKeepAlive()
UnixSocketAddress	getLocalSocketAddress()
UnixSocketAddress	getRemoteSocketAddress()
int	getSoTimeout()
boolean	isConnected()
boolean	isConnectionPending()
static UnixSocketChannel	open()
static UnixSocketChannel	open(UnixSocketAddress remote)
static UnixSocketChannel[]	pair()
void	setKeepAlive(boolean on)
void	setSoTimeout(int timeout)

Methods inherited from class jnr.enxio.channels.NativeSocketChannel

getFD, implCloseSelectableChannel, implConfigureBlocking, read, shutdownInput, shutdownOutput, validOps, write

Methods inherited from class java.nio.channels.spi.AbstractSelectableChannel

blockingLock, configureBlocking, implCloseChannel, isBlocking, isRegistered, keyFor, provider, register

Methods inherited from class java.nio.channels.SelectableChannel

register

Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel

begin, close, end, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Method Detail

open

public static final UnixSocketChannel open()
                                    throws IOException

Throws:

IOException

open

public static final UnixSocketChannel open(UnixSocketAddress remote)
                                    throws IOException

Throws:

IOException

pair

public static final UnixSocketChannel[] pair()
                                      throws IOException

Throws:

IOException

fromFD

public static final UnixSocketChannel fromFD(int fd)

Create a UnixSocketChannel to wrap an existing file descriptor (presumably itself a UNIX socket).

Parameters:

fd - the file descriptor to wrap

Returns:

the new UnixSocketChannel instance

fromFD

public static final UnixSocketChannel fromFD(int fd,
                       int ops)

Create a UnixSocketChannel to wrap an existing file descriptor (presumably itself a UNIX socket).

Parameters:

fd - the file descriptor to wrap

ops - the SelectionKey operations the socket supports

Returns:

the new UnixSocketChannel instance

connect

public boolean connect(UnixSocketAddress remote)
                throws IOException

Throws:

IOException

isConnected

public boolean isConnected()

isConnectionPending

public boolean isConnectionPending()

finishConnect

public boolean finishConnect()
                      throws IOException

Throws:

IOException

getRemoteSocketAddress

public final UnixSocketAddress getRemoteSocketAddress()

getLocalSocketAddress

public final UnixSocketAddress getLocalSocketAddress()

getCredentials

public final Credentials getCredentials()

Retrieves the credentials for this UNIX socket. If this socket channel is not in a connected state, this method will return null.

Returns:

the credentials of the remote; null if not connected

Throws:

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

See Also:

unix 7; SCM_CREDENTIALS

getKeepAlive

public boolean getKeepAlive()

setKeepAlive

public void setKeepAlive(boolean on)

getSoTimeout

public int getSoTimeout()

setSoTimeout

public void setSoTimeout(int timeout)