OrderedPairActor

gngs.OrderedPairActor

```
@groovy.util.logging.Log
class OrderedPairActor
extends groovyx.gpars.actor.DefaultActor
```
An actor that adds asynchronous writing to an OrderedPairWriter
Note that if you feed reads directly via the << operator, you may feed them faster than the underlying writer can write, which will cause the writes to be queued. This queue can expand, taking a large amount of memory. To limit memory, use the {@link#addAlignmentPair} method which will block if the number of pending writes execeeds {@link#maxPendingWrites}.
Authors:
Simon Sadedin

Inherited fields
Fields inherited from class	Fields
`class groovyx.gpars.actor.DefaultActor`	`CANNOT_SEND_REPLIES_NO_SENDER_HAS_BEEN_REGISTERED, TIMEOUT, serialHandle`

Properties Summary

Properties
Type	Name and description
`java.lang.Object`	`lock`
`int`	`maxPendingWrites`
`java.util.concurrent.atomic.AtomicInteger`	`pending`
`boolean`	`stopped`
`OrderedPairWriter`	`writer`

Constructor Summary

Constructors
Constructor and description
`OrderedPairActor (OrderedPairWriter writer)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`act()`
	`void`	`addAlignmentPair(gngs.SAMRecordPair pair)`
	`void`	`shutdown()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class groovyx.gpars.actor.DefaultActor`	groovyx.gpars.actor.DefaultActor#start(), groovyx.gpars.actor.DefaultActor#loop(java.lang.Runnable), groovyx.gpars.actor.DefaultActor#react(groovy.lang.Closure), groovyx.gpars.actor.DefaultActor#silentStart(), groovyx.gpars.actor.DefaultActor#stop(), groovyx.gpars.actor.DefaultActor#isActive(), groovyx.gpars.actor.DefaultActor#isFair(), groovyx.gpars.actor.DefaultActor#reply(java.lang.Object), groovyx.gpars.actor.DefaultActor#send(java.lang.Object), groovyx.gpars.actor.DefaultActor#terminate(), groovyx.gpars.actor.DefaultActor#makeFair(), groovyx.gpars.actor.DefaultActor#getSender(), groovyx.gpars.actor.DefaultActor#setParallelGroup(groovyx.gpars.group.PGroup), groovyx.gpars.actor.DefaultActor#replyIfExists(java.lang.Object), groovyx.gpars.actor.DefaultActor#join(), groovyx.gpars.actor.DefaultActor#join(long, java.util.concurrent.TimeUnit), groovyx.gpars.actor.DefaultActor#join(groovy.time.BaseDuration), groovyx.gpars.actor.DefaultActor#join(groovyx.gpars.actor.impl.MessageStream), groovyx.gpars.actor.DefaultActor#onStop(groovy.lang.Closure), groovyx.gpars.actor.DefaultActor#isActorThread(), groovyx.gpars.actor.DefaultActor#getJoinLatch(), groovyx.gpars.actor.DefaultActor#getParallelGroup(), groovyx.gpars.actor.DefaultActor#sendAndContinue(java.lang.Object, groovy.lang.Closure), groovyx.gpars.actor.DefaultActor#sendAndPromise(java.lang.Object), groovyx.gpars.actor.DefaultActor#threadBoundActor(), groovyx.gpars.actor.DefaultActor#leftShift(java.lang.Object), groovyx.gpars.actor.DefaultActor#call(java.lang.Object), groovyx.gpars.actor.DefaultActor#send(), groovyx.gpars.actor.DefaultActor#send(java.lang.Object, groovyx.gpars.actor.impl.MessageStream), groovyx.gpars.actor.DefaultActor#sendAndWait(java.lang.Object, groovy.time.Duration), groovyx.gpars.actor.DefaultActor#sendAndWait(java.lang.Object, long, java.util.concurrent.TimeUnit), groovyx.gpars.actor.DefaultActor#sendAndWait(java.lang.Object), groovyx.gpars.actor.DefaultActor#getRemoteClass(), groovyx.gpars.actor.DefaultActor#getOrCreateSerialHandle(), groovyx.gpars.actor.DefaultActor#wait(long), groovyx.gpars.actor.DefaultActor#wait(long, int), groovyx.gpars.actor.DefaultActor#wait(), groovyx.gpars.actor.DefaultActor#equals(java.lang.Object), groovyx.gpars.actor.DefaultActor#toString(), groovyx.gpars.actor.DefaultActor#hashCode(), groovyx.gpars.actor.DefaultActor#getClass(), groovyx.gpars.actor.DefaultActor#notify(), groovyx.gpars.actor.DefaultActor#notifyAll()

- Property Detail
  - java.lang.Object lock
  - int maxPendingWrites
  - java.util.concurrent.atomic.AtomicInteger pending
  - boolean stopped
  - OrderedPairWriter writer
- Constructor Detail
  - OrderedPairActor(OrderedPairWriter writer)
- Method Detail
  - @groovy.transform.CompileStatic void act()
  - void addAlignmentPair(gngs.SAMRecordPair pair)
  - void shutdown()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class OrderedPairActor

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.Object lock

int maxPendingWrites

java.util.concurrent.atomic.AtomicInteger pending

boolean stopped

OrderedPairWriter writer

Constructor Detail

OrderedPairActor(OrderedPairWriter writer)

Method Detail

@groovy.transform.CompileStatic void act()

void addAlignmentPair(gngs.SAMRecordPair pair)

void shutdown()