com.rapplogic.xbee.api
Class XBeeConfiguration

java.lang.Object
  extended by com.rapplogic.xbee.api.XBeeConfiguration

public class XBeeConfiguration
extends java.lang.Object


Constructor Summary
XBeeConfiguration()
           
 
Method Summary
 int getMaxQueueSize()
           
 ResponseFilter getResponseQueueFilter()
           
 int getSendSynchronousTimeout()
           
 boolean isShutdownHook()
           
 boolean isStartupChecks()
           
 XBeeConfiguration withMaxQueueSize(int size)
          Sets the maximum size of the internal queue that supports the getResponse(..) method.
 XBeeConfiguration withNoRequestResponseQueueFilter()
          Only adds responses that implement NoRequestResponse
 XBeeConfiguration withResponseQueueFilter(ResponseFilter filter)
           
 XBeeConfiguration withSendSynchronousTimeout(int sendSynchronousTimeout)
           
 XBeeConfiguration withShutdownHook(boolean shutdownHook)
          Controls is a startup check is performed when connecting to the XBee.
 XBeeConfiguration withStartupChecks(boolean startupChecks)
          Controls is a startup check is performed when connecting to the XBee.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XBeeConfiguration

public XBeeConfiguration()
Method Detail

withShutdownHook

public XBeeConfiguration withShutdownHook(boolean shutdownHook)
Controls is a startup check is performed when connecting to the XBee. The startup check attempts to determine the firmware type and if it is configured correctly for use with this software. Default is true.

Parameters:
startupChecks -

withStartupChecks

public XBeeConfiguration withStartupChecks(boolean startupChecks)
Controls is a startup check is performed when connecting to the XBee. The startup check attempts to determine the firmware type and if it is configured correctly for use with this software. Default is true.

Parameters:
startupChecks -

withMaxQueueSize

public XBeeConfiguration withMaxQueueSize(int size)
Sets the maximum size of the internal queue that supports the getResponse(..) method. Packets are removed from the head of the queue once this limit is reached. The default is 100

Parameters:
size -

withResponseQueueFilter

public XBeeConfiguration withResponseQueueFilter(ResponseFilter filter)

withSendSynchronousTimeout

public XBeeConfiguration withSendSynchronousTimeout(int sendSynchronousTimeout)

withNoRequestResponseQueueFilter

public XBeeConfiguration withNoRequestResponseQueueFilter()
Only adds responses that implement NoRequestResponse

Returns:

isStartupChecks

public boolean isStartupChecks()

getMaxQueueSize

public int getMaxQueueSize()

getResponseQueueFilter

public ResponseFilter getResponseQueueFilter()

getSendSynchronousTimeout

public int getSendSynchronousTimeout()

isShutdownHook

public boolean isShutdownHook()