Join us on the livestream at Android Dev Summit on 7-8 November 2018, starting at 10AM PDT!

ProxyFileDescriptorCallback

public abstract class ProxyFileDescriptorCallback
extends Object

java.lang.Object
   ↳ android.os.ProxyFileDescriptorCallback


Callback that handles file system requests from ProxyFileDescriptor. All callback methods except for onRelease should throw ErrnoException with proper errno on errors. See errno(3) and OsConstants. Typical errnos are

Summary

Public constructors

ProxyFileDescriptorCallback()

Public methods

void onFsync()

Ensures all the written data are stored in permanent storage device.

long onGetSize()

Returns size of bytes provided by the file descriptor.

int onRead(long offset, int size, byte[] data)

Provides bytes read from file descriptor.

abstract void onRelease()

Invoked after the file is closed.

int onWrite(long offset, int size, byte[] data)

Handles bytes written to file descriptor.

Inherited methods

Public constructors

ProxyFileDescriptorCallback

added in API level 26
public ProxyFileDescriptorCallback ()

Public methods

onFsync

added in API level 26
public void onFsync ()

Ensures all the written data are stored in permanent storage device. For example, if it has data stored in on memory cache, it needs to flush data to storage device.

Throws
ErrnoException ErrnoException containing E constants in OsConstants.

onGetSize

added in API level 26
public long onGetSize ()

Returns size of bytes provided by the file descriptor.

Returns
long Size of bytes.

Throws
ErrnoException ErrnoException containing E constants in OsConstants.

onRead

added in API level 26
public int onRead (long offset, 
                int size, 
                byte[] data)

Provides bytes read from file descriptor. It needs to return exact requested size of bytes unless it reaches file end.

Parameters
offset long: Offset in bytes from the file head specifying where to read bytes. If a seek operation is conducted on the file descriptor, then a read operation is requested, the offset refrects the proper position of requested bytes.

size int: Size for read bytes.

data byte: Byte array to store read bytes.

Returns
int Size of bytes returned by the function.

Throws
ErrnoException ErrnoException containing E constants in OsConstants.

onRelease

added in API level 26
public abstract void onRelease ()

Invoked after the file is closed.

onWrite

added in API level 26
public int onWrite (long offset, 
                int size, 
                byte[] data)

Handles bytes written to file descriptor.

Parameters
offset long: Offset in bytes from the file head specifying where to write bytes. If a seek operation is conducted on the file descriptor, then a write operation is requested, the offset refrects the proper position of requested bytes.

size int: Size for write bytes.

data byte: Byte array to be written to somewhere.

Returns
int Size of bytes processed by the function.

Throws
ErrnoException ErrnoException containing E constants in OsConstants.