com.scalar.dl.ledger.server

Class SynchronizedGateKeeper

java.lang.Object

com.scalar.dl.ledger.server.SynchronizedGateKeeper

All Implemented Interfaces:

GateKeeper

@ThreadSafe
public class SynchronizedGateKeeper
extends java.lang.Object
implements GateKeeper

Constructor Summary

Constructors

Constructor and Description
SynchronizedGateKeeper()

Method Summary

Modifier and Type	Method and Description
boolean	awaitDrained(long timeout, java.util.concurrent.TimeUnit unit) Waits for the server to finish outstanding requests, giving up if the timeout is reached.
void	close() Closes the gate to disallow incoming requests to be processed.
int	getNumOutstandingRequests() Returns the number of outstanding requests.
boolean	isOpen() Returns if the gate is open or not.
boolean	letIn() Lets a new request in to process it in the server if the gate is open.
void	letOut() Lets a processed request out.
void	open() Opens the gate to allow incoming requests to be processed.

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronizedGateKeeper

public SynchronizedGateKeeper()

Method Detail

open

public void open()

Description copied from interface: GateKeeper

Opens the gate to allow incoming requests to be processed.

Specified by:

open in interface GateKeeper

close

public void close()

Description copied from interface: GateKeeper

Closes the gate to disallow incoming requests to be processed. After this call returns, new requests are rejected. Note that this method will not wait for outstanding requests to finish before returning. awaitDrained(long, TimeUnit) needs to be called to wait for outstanding requests to finish.

Specified by:

close in interface GateKeeper

isOpen

public boolean isOpen()

Description copied from interface: GateKeeper

Returns if the gate is open or not.

Specified by:

isOpen in interface GateKeeper

Returns:

true if the gate is open

getNumOutstandingRequests

public int getNumOutstandingRequests()

Description copied from interface: GateKeeper

Returns the number of outstanding requests.

Specified by:

getNumOutstandingRequests in interface GateKeeper

Returns:

the number of outstanding requests

awaitDrained

public boolean awaitDrained(long timeout,
                            java.util.concurrent.TimeUnit unit)
                     throws java.lang.InterruptedException

Description copied from interface: GateKeeper

Waits for the server to finish outstanding requests, giving up if the timeout is reached.

Specified by:

awaitDrained in interface GateKeeper

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

true if the server finishes outstanding requests and false otherwise

Throws:

java.lang.InterruptedException - if interrupted while waiting

letIn

public boolean letIn()

Description copied from interface: GateKeeper

Lets a new request in to process it in the server if the gate is open.

Specified by:

letIn in interface GateKeeper

Returns:

true if the gate is open

letOut

public void letOut()

Description copied from interface: GateKeeper

Lets a processed request out.

Specified by:

letOut in interface GateKeeper