org.aksw.jena_sparql_api.io.endpoint

Class ConcurrentFileEndpoint

java.lang.Object

org.aksw.jena_sparql_api.io.endpoint.ConcurrentFileEndpoint

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, WritableByteChannel

public class ConcurrentFileEndpoint
extends Object
implements WritableByteChannel

Class for allowing an arbitrary number of concurrent reads to a file while it is being written to. Readers reaching the end of their respective channel will block and wait for more data as long as the write channel remains open. An endpoint combines sink and source capabilities. The ConcurrentFileEndpoint is a WritableByteChannel that supports creating new InputStreams over the data. At present, these InputStreams are not seekable.

Author:

raven

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isAbandoned
protected CompletableFuture<Path>	isDone
protected Path	path
protected SeekableByteChannel	writeChannel

Constructor Summary

Constructors

Constructor and Description
ConcurrentFileEndpoint(Path path, SeekableByteChannel writeChannel)

Method Summary

Modifier and Type	Method and Description
void	abandon() Only for the creating thread! Indicate that the writing to the endpoint has been abandoned.
void	close()
static ConcurrentFileEndpoint	create(Path path, OpenOption... options)
CompletableFuture<Path>	getIsDone()
Path	getPath()
boolean	isAbandoned()
boolean	isOpen()
static void	main(String[] args)
ReadableByteChannel	newReadChannel()
String	toString()
int	write(ByteBuffer src)

Methods inherited from class java.lang.Object

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

Field Detail

path

protected Path path

writeChannel

protected SeekableByteChannel writeChannel

isAbandoned

protected boolean isAbandoned

isDone

protected CompletableFuture<Path> isDone

Constructor Detail

ConcurrentFileEndpoint

public ConcurrentFileEndpoint(Path path,
                              SeekableByteChannel writeChannel)

Method Detail

create

public static ConcurrentFileEndpoint create(Path path,
                                            OpenOption... options)
                                     throws IOException

Throws:

IOException

getPath

public Path getPath()

isAbandoned

public boolean isAbandoned()

abandon

public void abandon()

Only for the creating thread! Indicate that the writing to the endpoint has been abandoned. Must be indicated before closing the endpoint, as any readers will also check the isOpen state upon reaching the end of data, and if there is no abandon state they will assume successful completion.

getIsDone

public CompletableFuture<Path> getIsDone()

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Throws:

IOException

write

public int write(ByteBuffer src)
          throws IOException

Specified by:

write in interface WritableByteChannel

Throws:

IOException

newReadChannel

public ReadableByteChannel newReadChannel()
                                   throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

main

public static void main(String[] args)
                 throws IOException,
                        InterruptedException

Throws:

IOException

InterruptedException