net.kano.joscar.snac
Class SnacRequestTimeoutEvent

java.lang.Object
  extended bySnacRequestTimeoutEvent

public class SnacRequestTimeoutEvent
extends java.lang.Object

An event fired when a SNAC request "times out." This is not a bad thing; in fact, it happens to almost every SNAC request. See SnacRequest for details.


Constructor Summary
protected SnacRequestTimeoutEvent(FlapProcessor flapProcessor, ClientSnacProcessor snacProcessor, SnacRequest request, int ttl)
          Creates a new timeout event with the given properties.
 
Method Summary
 FlapProcessor getFlapProcessor()
          Returns the FLAP connection on which the associated request timed out.
 SnacRequest getRequest()
          Returns the request that timed out.
 ClientSnacProcessor getSnacProcessor()
          Returns the SNAC connection on which the associated request timed out.
 int getTtl()
          Returns the maximum "time to live," in seconds, that this request's lifetime exceeded, causing it to time out.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SnacRequestTimeoutEvent

protected SnacRequestTimeoutEvent(FlapProcessor flapProcessor,
                                  ClientSnacProcessor snacProcessor,
                                  SnacRequest request,
                                  int ttl)
Creates a new timeout event with the given properties.

Parameters:
flapProcessor - the FLAP connection on which the given request timed out
snacProcessor - the SNAC connection on which the given request timed out
request - the request that timed out
ttl - the time-to-live that the associated request's lifetime exceeded
Method Detail

getFlapProcessor

public FlapProcessor getFlapProcessor()
Returns the FLAP connection on which the associated request timed out.

Returns:
the FLAP connection associated with this event

getSnacProcessor

public ClientSnacProcessor getSnacProcessor()
Returns the SNAC connection on which the associated request timed out.

Returns:
the SNAC connection associated with this event

getRequest

public SnacRequest getRequest()
Returns the request that timed out.

Returns:
the request that timed out

getTtl

public int getTtl()
Returns the maximum "time to live," in seconds, that this request's lifetime exceeded, causing it to time out.

Returns:
the "time to live" that this request exceeded, in seconds