Class FileChannelActor

java.lang.Object

org.tasktide.mutex.actor.IntraProcessActor

org.tasktide.mutex.actor.FileChannelActor

All Implemented Interfaces:

MutexActor

public class FileChannelActor
extends IntraProcessActor

Package private class for managing the acquisitions and releasing of FileChannel

Constructor Summary

Constructors

Constructor	Description
FileChannelActor()

Method Summary

Modifier and Type	Method	Description
boolean	acquire(Path targetFile)	Acquire a lock on composed target
boolean	acquire(Mutex mutex)	Acquire lock on provided Mutex
Mutex	fetchActiveFieldValue()	Provides the value for the active Mutex
MutexState	getState()	Get mutex state
MutexStrategy	getStrategy()	Get MutexStrategy
boolean	release()	Release lock
boolean	release(Path targetFile)	Release lock on target file provided
boolean	release(Mutex mutex)	Release lock
void	setState(MutexState newState)	Set Mutex state
void	waitForLock(Mutex mutex)	Wait for lock to be acquired

Methods inherited from class Object

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

Constructor Details

FileChannelActor

public FileChannelActor()

Method Details

getStrategy

public MutexStrategy getStrategy()

Get MutexStrategy

Returns:

FileChannelStrategy

waitForLock

public void waitForLock(Mutex mutex)
                 throws MutexCheckedException

Wait for lock to be acquired

Parameters:

mutex -

Throws:

MutexCheckedException

acquire

public boolean acquire(Path targetFile)
                throws MutexCheckedException

Acquire a lock on composed target

Parameters:

targetFile -

Returns:

boolean

Throws:

MutexCheckedException

acquire

public boolean acquire(Mutex mutex)
                throws MutexCheckedException

Acquire lock on provided Mutex

Parameters:

mutex -

Returns:

boolean

Throws:

MutexCheckedException

release

public boolean release(Mutex mutex)
                throws MutexCheckedException

Release lock

Parameters:

mutex -

Returns:

boolean

Throws:

MutexCheckedException

release

public boolean release(Path targetFile)
                throws MutexCheckedException

Release lock on target file provided

Parameters:

targetFile -

Returns:

boolean

Throws:

MutexCheckedException

release

public boolean release()
                throws MutexCheckedException

Release lock

Returns:

boolean

Throws:

MutexCheckedException

fetchActiveFieldValue

public Mutex fetchActiveFieldValue()

Provides the value for the active Mutex

Returns:

Mutex

getState

public MutexState getState()

Get mutex state

Returns:

MutexState

setState

public void setState(MutexState newState)

Set Mutex state

Parameters:

newState -