org.simpleframework.transport.reactor
Class SynchronousReactor

java.lang.Object
  org.simpleframework.transport.reactor.SynchronousReactor

All Implemented Interfaces:

Reactor

public class SynchronousReactor
extends Object
implements Reactor

The SynchronousReactor object is used to execute the ready operations of within a single synchronous thread. This is used when the I/O operations to be performed do not require much time to execute and so will not block the execution thread.

Author:

Niall Gallagher

Constructor Summary

SynchronousReactor()
Constructor for the SynchronousReactor object.

SynchronousReactor(boolean cancel)
Constructor for the SynchronousReactor object.

Method Summary

void	process(Operation task) This method is used to execute the provided operation without the need to specifically check for I/O events.
void	process(Operation task, int require) This method is used to execute the provided operation when there is an I/O event that task is interested in.
void	stop() This is used to stop the reactor so that further requests to execute operations does nothing.

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronousReactor

public SynchronousReactor()
                   throws IOException

Constructor for the SynchronousReactor object. This is used to create a reactor that does not require thread pooling to execute the ready operations. All I/O operations are run in the selection thread and should complete quickly.

Throws:

IOException

SynchronousReactor

public SynchronousReactor(boolean cancel)
                   throws IOException

Constructor for the SynchronousReactor object. This is used to create a reactor that does not require thread pooling to execute the ready operations. All I/O operations are run in the selection thread and should complete quickly.

Parameters:

cancel - determines the selection key should be cancelled

Throws:

IOException

Method Detail

process

public void process(Operation task)
             throws IOException

This method is used to execute the provided operation without the need to specifically check for I/O events. This is used if the operation knows that the SelectableChannel is ready, or if the I/O operation can be performed without knowing if the channel is ready. Typically this is an efficient means to perform a poll rather than a select on the channel.

Specified by:

process in interface Reactor

Parameters:

task - this is the task to execute immediately

Throws:

IOException

process

public void process(Operation task,
                    int require)
             throws IOException

This method is used to execute the provided operation when there is an I/O event that task is interested in. This will used the operations SelectableChannel object to determine the events that are ready on the channel. If this reactor is interested in any of the ready events then the task is executed.

Specified by:

process in interface Reactor

Parameters:

task - this is the task to execute on interested events

require - this is the bit-mask value for interested events

Throws:

IOException

stop

public void stop()
          throws IOException

This is used to stop the reactor so that further requests to execute operations does nothing. This will clean up all of the reactors resources and unregister any operations that are currently awaiting execution. This should be used to ensure any threads used by the reactor graceful stop.

Specified by:

stop in interface Reactor

Throws:

IOException