UserAgent.HeartBeatTask (JORAM 5.24.0 API)

java.lang.Object
- java.util.TimerTask
- - org.objectweb.joram.mom.proxies.UserAgent.HeartBeatTask

All Implemented Interfaces:

Externalizable, Serializable, Runnable

Enclosing class:

UserAgent
```
class UserAgent.HeartBeatTask
extends TimerTask
implements Externalizable
```
Timer task responsible for closing the connection if it has not sent any requests for the duration 'timeout'.

Field Summary

Fields
Modifier and Type	Field	Description
`private Integer`	`key`
`private long`	`lastRequestDate`
`private int`	`timeout`	Maximum time between two requests on the connection (This value is normally the double of the hear-beat period).
`private AgentId`	`userId`

Constructor Summary

Constructors
Constructor Description

HeartBeatTask()

HeartBeatTask(int timeout, Integer key, AgentId userId)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`readExternal(ObjectInput in)`
`void`	`run()`
`void`	`start()`
`void`	`touch()`
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.util.TimerTask
cancel, scheduledExecutionTime

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- timeout
```
private transient int timeout
```
  Maximum time between two requests on the connection (This value is normally the double of the hear-beat period).
- key
```
private transient Integer key
```
- lastRequestDate
```
private transient long lastRequestDate
```
- userId
```
private transient AgentId userId
```

Constructor Detail

HeartBeatTask

HeartBeatTask(int timeout,
              Integer key,
              AgentId userId)

HeartBeatTask
```
public HeartBeatTask()
```

Method Detail
- run
```
public void run()
```
  Specified by:
  
  run in interface Runnable
  
  Specified by:
  
  run in class TimerTask
- start
```
public void start()
           throws IOException
```
  Throws:
  
  IOException
- touch
```
public void touch()
```
- readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
  Specified by:
  
  readExternal in interface Externalizable
  
  Throws:
  
  IOException
  
  ClassNotFoundException
  
  See Also:
  
  Externalizable.readExternal(java.io.ObjectInput)
- writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
  Specified by:
  
  writeExternal in interface Externalizable
  
  Throws:
  
  IOException
  
  See Also:
  
  Externalizable.writeExternal(java.io.ObjectOutput)