avail/avail.io/IOSystem

IOSystem

class IOSystem

This aggregates socket and file I/O information and behavior specific to an AvailRuntime.

Constructors

IOSystem

constructor()

Types

BufferKey

class BufferKey(fileHandle: IOSystem.FileHandle, startPosition: Long)

A BufferKey identifies a file buffer in the cache.

Companion

object Companion

FileHandle

class FileHandle(val filename: A_String, val alignment: Int, val canRead: Boolean, val canWrite: Boolean, val channel: AsynchronousFileChannel)

A FileHandle is an abstraction which wraps an AsynchronousFileChannel with some additional information like filename and buffer alignment. It gets stuffed in a pojo in a property of the atom that serves as Avail's most basic view of a file handle. Sockets use a substantially similar technique.

Properties

fileExecutor

val fileExecutor: ThreadPoolExecutor

The thread pool executor for asynchronous file operations performed on behalf of this Avail runtime.

Functions

destroy

fun destroy()

Destroy all data structures used by this AvailRuntime. Also disassociate it from the current Thread's local storage.

discardBuffer

fun discardBuffer(key: IOSystem.BufferKey)

Discard the container responsible for the buffer indicated by the supplied key.

executeFileTask

fun executeFileTask(task: Runnable)

Schedule the specified task for eventual execution by the thread pool executor for asynchronous file operations. The implementation is free to run the task immediately or delay its execution arbitrarily. The task will not execute on an Avail thread.

getBuffer

fun getBuffer(key: IOSystem.BufferKey): Mutable<A_Tuple?>

Answer the container responsible for the buffer indicated by the supplied key.

openFile

fun openFile(path: Path, options: Set<OpenOption>, vararg attributes: FileAttribute<*>): AsynchronousFileChannel

Open an asynchronous file channel for the specified path.

openFileWithAvailThread

fun openFileWithAvailThread(path: Path, runtime: AvailRuntime, options: Set<OpenOption>, vararg attributes: FileAttribute<*>): AsynchronousFileChannel

Open an asynchronous file channel for the specified path.

openServerSocket

fun openServerSocket(): AsynchronousServerSocketChannel

Open an asynchronous server.

openSocket

fun openSocket(): AsynchronousSocketChannel

Open an asynchronous socket.