OnFileDescriptorEventListener
interface OnFileDescriptorEventListener
android.os.MessageQueue.OnFileDescriptorEventListener |
A listener which is invoked when file descriptor related events occur.
Summary
Constants | |
---|---|
static Int |
File descriptor event: Indicates that the file descriptor encountered a fatal error. |
static Int |
File descriptor event: Indicates that the file descriptor is ready for input operations, such as reading. |
static Int |
File descriptor event: Indicates that the file descriptor is ready for output operations, such as writing. |
Public methods | |
---|---|
abstract Int |
onFileDescriptorEvents(fd: FileDescriptor, events: Int) Called when a file descriptor receives events. |
Constants
EVENT_ERROR
static val EVENT_ERROR: Int
File descriptor event: Indicates that the file descriptor encountered a fatal error.
File descriptor errors can occur for various reasons. One common error is when the remote peer of a socket or pipe closes its end of the connection.
This event may be generated at any time regardless of whether the EVENT_ERROR
event mask was specified when the listener was added.
Value: 4
EVENT_INPUT
static val EVENT_INPUT: Int
File descriptor event: Indicates that the file descriptor is ready for input operations, such as reading.
The listener should read all available data from the file descriptor then return true
to keep the listener active or false
to remove the listener.
In the case of a socket, this event may be generated to indicate that there is at least one incoming connection that the listener should accept.
This event will only be generated if the EVENT_INPUT
event mask was specified when the listener was added.
Value: 1
EVENT_OUTPUT
static val EVENT_OUTPUT: Int
File descriptor event: Indicates that the file descriptor is ready for output operations, such as writing.
The listener should write as much data as it needs. If it could not write everything at once, then it should return true
to keep the listener active. Otherwise, it should return false
to remove the listener then re-register it later when it needs to write something else.
This event will only be generated if the EVENT_OUTPUT
event mask was specified when the listener was added.
Value: 2
Public methods
onFileDescriptorEvents
abstract fun onFileDescriptorEvents(
fd: FileDescriptor,
events: Int
): Int
Called when a file descriptor receives events.
Parameters | |
---|---|
fd |
FileDescriptor: The file descriptor. This value cannot be null . |
events |
Int: The set of events that occurred: a combination of the EVENT_INPUT , EVENT_OUTPUT , and EVENT_ERROR event masks. Value is either 0 or a combination of android.os.MessageQueue.OnFileDescriptorEventListener#EVENT_INPUT , android.os.MessageQueue.OnFileDescriptorEventListener#EVENT_OUTPUT , and android.os.MessageQueue.OnFileDescriptorEventListener#EVENT_ERROR |
Return | |
---|---|
Int |
The new set of events to watch, or 0 to unregister the listener. Value is either 0 or a combination of android.os.MessageQueue.OnFileDescriptorEventListener#EVENT_INPUT , android.os.MessageQueue.OnFileDescriptorEventListener#EVENT_OUTPUT , and android.os.MessageQueue.OnFileDescriptorEventListener#EVENT_ERROR |
See Also