Class FileDescriptor

java.lang.Object

io.netty.channel.unix.FileDescriptor

Direct Known Subclasses:

Socket

public class FileDescriptor
extends Object

Native FileDescriptor implementation which allows to wrap an int and provide a FileDescriptor for it.

Constructor Summary

Constructors

Constructor	Description
FileDescriptor(int fd)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the file descriptor.
boolean	equals(Object o)
static FileDescriptor	from(File file)	Open a new FileDescriptor for the given File, write-only.
static FileDescriptor	from(String path)	Open a new FileDescriptor for the given path, write-only.
int	hashCode()
final int	intValue()	Return the int value of the filedescriptor.
boolean	isOpen()	Returns true if the file descriptor is open.
protected boolean	markClosed()
static FileDescriptor[]	pipe()
final int	read(ByteBuffer buf, int pos, int limit)
final int	readAddress(long address, int pos, int limit)
String	toString()
final int	write(ByteBuffer buf, int pos, int limit)
final int	writeAddress(long address, int pos, int limit)
final long	writev(ByteBuffer[] buffers, int offset, int length, long maxBytesToWrite)
final long	writevAddresses(long memoryAddress, int length)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FileDescriptor

public FileDescriptor(int fd)

Method Details

intValue

public final int intValue()

Return the int value of the filedescriptor.

markClosed

protected boolean markClosed()

close

public void close()
           throws IOException

Close the file descriptor.

Throws:

IOException

isOpen

public boolean isOpen()

Returns true if the file descriptor is open.

write

public final int write(ByteBuffer buf,
 int pos,
 int limit)
                throws IOException

Throws:

IOException

writeAddress

public final int writeAddress(long address,
 int pos,
 int limit)
                       throws IOException

Throws:

IOException

writev

public final long writev(ByteBuffer[] buffers,
 int offset,
 int length,
 long maxBytesToWrite)
                  throws IOException

Throws:

IOException

writevAddresses

public final long writevAddresses(long memoryAddress,
 int length)
                           throws IOException

Throws:

IOException

read

public final int read(ByteBuffer buf,
 int pos,
 int limit)
               throws IOException

Throws:

IOException

readAddress

public final int readAddress(long address,
 int pos,
 int limit)
                      throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

from

public static FileDescriptor from(String path)
                           throws IOException

Open a new FileDescriptor for the given path, write-only.

WARNING: if path already exists it is truncated to zero length; if it does not exist it is created with mode 0666 & ~umask. Do not pass untrusted or externally-derived paths to this method.

Throws:

IOException

from

public static FileDescriptor from(File file)
                           throws IOException

Open a new FileDescriptor for the given File, write-only.

WARNING: see from(String): an existing file is truncated and a missing one is created.

Throws:

IOException

pipe

public static FileDescriptor[] pipe()
                             throws IOException

Returns:

[0] = read end, [1] = write end

Throws:

IOException