org.flowcomputing.commons.resgc

Class ResCollector<HOLDER extends Holder<MRES,HOLDER>,MRES>

java.lang.Object

org.flowcomputing.commons.resgc.ResCollector<HOLDER,MRES>

Type Parameters:

HOLDER - holder type for any kind of resource.

MRES - resource type to be holden.

All Implemented Interfaces:

Collector<HOLDER,MRES>

public class ResCollector<HOLDER extends Holder<MRES,HOLDER>,MRES>
extends Object
implements Collector<HOLDER,MRES>

Collect resource holders that need to be collected after utilization. It manages to release resource in explicit way and we have change to be notified when its resource is going to be release. In addition, It embedded mechanism to allow resource to be forced release in advance.

Author:

wg

Field Summary

Fields

Modifier and Type	Field and Description
static long	TERMCHECKTIMEOUT
static long	WAITQUEUETIMEOUT
static long	WAITRECLAIMTIMEOUT
static long	WAITTERMTIMEOUT

Constructor Summary

Constructors

Constructor and Description
ResCollector(ResReclaim<MRES> reclaimer) constructor to accept a resource reclaimer that is used to actual its resource when needed.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	close()
boolean	close(long recltmout, long termtmout) close this collector.
void	destroyRes(MRES mres) destroy the resource
void	destroyRes(Reference<? extends HOLDER> ref) destroy a specified holden resource.
void	register(HOLDER holder) Register a holder and its resource to be managed.
void	removeRef(Reference<HOLDER> ref) Remove a Ref that cannot be used alone.
void	unregister(HOLDER holder) Unregister a managed resource.
void	waitReclaimCoolDown(long timeout) wait for reclaim termination.

Methods inherited from class java.lang.Object

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

Field Detail

WAITRECLAIMTIMEOUT

public static final long WAITRECLAIMTIMEOUT

See Also:

Constant Field Values

WAITQUEUETIMEOUT

public static final long WAITQUEUETIMEOUT

See Also:

Constant Field Values

WAITTERMTIMEOUT

public static final long WAITTERMTIMEOUT

See Also:

Constant Field Values

TERMCHECKTIMEOUT

public static final long TERMCHECKTIMEOUT

See Also:

Constant Field Values

Constructor Detail

ResCollector

public ResCollector(ResReclaim<MRES> reclaimer)

constructor to accept a resource reclaimer that is used to actual its resource when needed.

Parameters:

reclaimer - a reclaimer object for managed resource reclaim.

Method Detail

register

public void register(HOLDER holder)

Description copied from interface: Collector

Register a holder and its resource to be managed.

Specified by:

register in interface Collector<HOLDER extends Holder<MRES,HOLDER>,MRES>

Parameters:

holder - a holder to be registered

unregister

public void unregister(HOLDER holder)

Description copied from interface: Collector

Unregister a managed resource.

Specified by:

unregister in interface Collector<HOLDER extends Holder<MRES,HOLDER>,MRES>

Parameters:

holder - a holder to be unregistered

removeRef

public void removeRef(Reference<HOLDER> ref)

Description copied from interface: Collector

Remove a Ref that cannot be used alone.

Specified by:

removeRef in interface Collector<HOLDER extends Holder<MRES,HOLDER>,MRES>

Parameters:

ref - a reference object to be removed

destroyRes

public void destroyRes(Reference<? extends HOLDER> ref)

destroy a specified holden resource.

Specified by:

destroyRes in interface Collector<HOLDER extends Holder<MRES,HOLDER>,MRES>

Parameters:

ref - a specified reference that is referring a holder

destroyRes

public void destroyRes(MRES mres)

Description copied from interface: Collector

destroy the resource

Specified by:

destroyRes in interface Collector<HOLDER extends Holder<MRES,HOLDER>,MRES>

Parameters:

mres - a resource to be destroyed

waitReclaimCoolDown

public void waitReclaimCoolDown(long timeout)

wait for reclaim termination.

Parameters:

timeout - specify a timeout to reclaim

close

public boolean close(long recltmout,
            long termtmout)

Description copied from interface: Collector

close this collector.

Specified by:

close in interface Collector<HOLDER extends Holder<MRES,HOLDER>,MRES>

Parameters:

recltmout - specify a timeout for reclaiming

termtmout - specify a timeout for terminating worker thread

Returns:

true if closed gracefully otherwise timeout.

close

public boolean close()