Package jnr.unixsocket

Class UnixSocketChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

java.nio.channels.SocketChannel

jnr.unixsocket.impl.AbstractNativeSocketChannel

jnr.unixsocket.UnixSocketChannel

All Implemented Interfaces:

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

public class UnixSocketChannel
extends AbstractNativeSocketChannel

A Channel implementation that uses a native unix socket

Method Summary

Modifier and Type	Method	Description
UnixSocketChannel	bind(SocketAddress local)
boolean	connect(SocketAddress remote)
boolean	connect(UnixSocketAddress remote)
static UnixSocketChannel	create()
boolean	finishConnect()
static UnixSocketChannel	fromFD(int fd)	Create a UnixSocketChannel to wrap an existing file descriptor (presumably itself a UNIX socket).
SocketAddress	getLocalAddress()
UnixSocketAddress	getLocalSocketAddress()
<T> T	getOption(SocketOption<T> name)
SocketAddress	getRemoteAddress()
UnixSocketAddress	getRemoteSocketAddress()
boolean	isConnected()
boolean	isConnectionPending()
static UnixSocketChannel	open()
static UnixSocketChannel	open(UnixSocketAddress remote)
static UnixSocketChannel[]	pair()
int	read(ByteBuffer dst)
<T> SocketChannel	setOption(SocketOption<T> name, T value)
UnixSocket	socket()
Set<SocketOption<?>>	supportedOptions()
int	write(ByteBuffer src)
long	write(ByteBuffer[] srcs, int offset, int length)

Methods inherited from class jnr.unixsocket.impl.AbstractNativeSocketChannel

getFD, implCloseSelectableChannel, implConfigureBlocking, read, setFD, shutdownInput, shutdownOutput

Methods inherited from class java.nio.channels.SocketChannel

open, read, 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

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

create

public static final UnixSocketChannel create()
                                      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

connect

public boolean connect(UnixSocketAddress remote)
                throws IOException

Throws:

IOException

isConnected

public boolean isConnected()

Specified by:

isConnected in class SocketChannel

isConnectionPending

public boolean isConnectionPending()

Specified by:

isConnectionPending in class SocketChannel

finishConnect

public boolean finishConnect()
                      throws IOException

Specified by:

finishConnect in class SocketChannel

Throws:

IOException

getRemoteSocketAddress

public final UnixSocketAddress getRemoteSocketAddress()

getLocalSocketAddress

public final UnixSocketAddress getLocalSocketAddress()

connect

public boolean connect(SocketAddress remote)
                throws IOException

Specified by:

connect in class SocketChannel

Throws:

IOException

socket

public UnixSocket socket()

Specified by:

socket in class SocketChannel

write

public long write(ByteBuffer[] srcs,
                  int offset,
                  int length)
           throws IOException

Specified by:

write in interface GatheringByteChannel

Overrides:

write in class AbstractNativeSocketChannel

Throws:

IOException

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Overrides:

read in class AbstractNativeSocketChannel

Throws:

IOException

write

public int write(ByteBuffer src)
          throws IOException

Specified by:

write in interface WritableByteChannel

Overrides:

write in class AbstractNativeSocketChannel

Throws:

IOException

getRemoteAddress

public SocketAddress getRemoteAddress()
                               throws IOException

Specified by:

getRemoteAddress in class SocketChannel

Throws:

IOException

getLocalAddress

public SocketAddress getLocalAddress()
                              throws IOException

Specified by:

getLocalAddress in interface NetworkChannel

Specified by:

getLocalAddress in class SocketChannel

Throws:

IOException

supportedOptions

public final Set<SocketOption<?>> supportedOptions()

getOption

public <T> T getOption(SocketOption<T> name)
                throws IOException

Throws:

IOException

setOption

public <T> SocketChannel setOption(SocketOption<T> name,
                                   T value)
                            throws IOException

Specified by:

setOption in interface NetworkChannel

Specified by:

setOption in class SocketChannel

Throws:

IOException

bind

public UnixSocketChannel bind(SocketAddress local)
                       throws IOException

Specified by:

bind in interface NetworkChannel

Specified by:

bind in class SocketChannel

Throws:

IOException