Package io.netty.channel.uring

Class IoUringFileRegion

java.lang.Object

io.netty.channel.uring.IoUringFileRegion

All Implemented Interfaces:

FileRegion, ReferenceCounted

final class IoUringFileRegion
extends java.lang.Object
implements FileRegion

Field Summary

Fields

Modifier and Type	Field	Description
(package private) DefaultFileRegion	fileRegion
private static InternalLogger	logger
private FileDescriptor[]	pipe
private int	pipeLen
private static short	SPLICE_TO_PIPE
private static short	SPLICE_TO_SOCKET
private int	transferred

Constructor Summary

Constructors

Constructor	Description
IoUringFileRegion(DefaultFileRegion fileRegion)

Method Summary

Modifier and Type	Method	Description
private void	closePipeIfNeeded()
private static void	closeSilently(FileDescriptor fd)
long	count()	Returns the number of bytes to transfer.
(package private) int	handleResult(int result, short data)	Handle splice result
(package private) void	open()
long	position()	Returns the offset in the file where the transfer began.
int	refCnt()	Returns the reference count of this object.
boolean	release()	Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
boolean	release(int decrement)	Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
FileRegion	retain()	Increases the reference count by 1.
FileRegion	retain(int increment)	Increases the reference count by the specified increment.
(package private) IoUringIoOps	splice(int fd)
(package private) IoUringIoOps	spliceToPipe()
private IoUringIoOps	spliceToSocket(int socket, int len)
FileRegion	touch()	Records the current access location of this object for debugging purposes.
FileRegion	touch(java.lang.Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.
long	transfered()	Returns the bytes which was transferred already.
long	transferred()	Returns the bytes which was transferred already.
long	transferTo(java.nio.channels.WritableByteChannel target, long position)	Transfers the content of this file region to the specified channel.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final InternalLogger logger

SPLICE_TO_PIPE

private static final short SPLICE_TO_PIPE

See Also:

Constant Field Values

SPLICE_TO_SOCKET

private static final short SPLICE_TO_SOCKET

See Also:

Constant Field Values

fileRegion

final DefaultFileRegion fileRegion

pipe

private FileDescriptor[] pipe

transferred

private int transferred

pipeLen

private int pipeLen

Constructor Detail

IoUringFileRegion

IoUringFileRegion(DefaultFileRegion fileRegion)

Method Detail

open

void open()
   throws java.io.IOException

Throws:

java.io.IOException

splice

IoUringIoOps splice(int fd)

spliceToPipe

IoUringIoOps spliceToPipe()

spliceToSocket

private IoUringIoOps spliceToSocket(int socket,
                                    int len)

handleResult

int handleResult(int result,
                 short data)

Handle splice result

Parameters:

result - the result

data - the data that was submitted as part of the SPLICE.

Returns:

the number of bytes that should be considered to be transferred.

position

public long position()

Description copied from interface: FileRegion

Returns the offset in the file where the transfer began.

Specified by:

position in interface FileRegion

transfered

public long transfered()

Description copied from interface: FileRegion

Returns the bytes which was transferred already.

Specified by:

transfered in interface FileRegion

transferred

public long transferred()

Description copied from interface: FileRegion

Returns the bytes which was transferred already.

Note: some asynchronous transports (such as the io_uring transport when falling back to a chunked send for non-DefaultFileRegion implementations) advance this counter when bytes have been queued for submission, which may be before they reach the peer. If the channel is closed or the write fails after queuing, the reported value may overstate the number of bytes actually delivered.

Specified by:

transferred in interface FileRegion

count

public long count()

Description copied from interface: FileRegion

Returns the number of bytes to transfer.

Specified by:

count in interface FileRegion

transferTo

public long transferTo(java.nio.channels.WritableByteChannel target,
                       long position)

Description copied from interface: FileRegion

Transfers the content of this file region to the specified channel.

Specified by:

transferTo in interface FileRegion

Parameters:

target - the destination of the transfer

position - the relative offset of the file where the transfer begins from. For example, 0 will make the transfer start from FileRegion.position()th byte and FileRegion.count() - 1 will make the last byte of the region transferred.

retain

public FileRegion retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface FileRegion

Specified by:

retain in interface ReferenceCounted

retain

public FileRegion retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface FileRegion

Specified by:

retain in interface ReferenceCounted

touch

public FileRegion touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface FileRegion

Specified by:

touch in interface ReferenceCounted

touch

public FileRegion touch(java.lang.Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Specified by:

touch in interface FileRegion

Specified by:

touch in interface ReferenceCounted

refCnt

public int refCnt()

Description copied from interface: ReferenceCounted

Returns the reference count of this object. If 0, it means this object has been deallocated.

Specified by:

refCnt in interface ReferenceCounted

release

public boolean release()

Description copied from interface: ReferenceCounted

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

release

public boolean release(int decrement)

Description copied from interface: ReferenceCounted

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

closePipeIfNeeded

private void closePipeIfNeeded()

closeSilently

private static void closeSilently(FileDescriptor fd)