com.lmax.api.heartbeat
Class HeartbeatRequest

java.lang.Object
  extended by com.lmax.api.heartbeat.HeartbeatRequest
All Implemented Interfaces:
com.lmax.api.internal.Request

public class HeartbeatRequest
extends java.lang.Object
implements com.lmax.api.internal.Request

A request for a heartbeat from the Lmax Trader.


Constructor Summary
HeartbeatRequest(java.lang.String token)
          Create a heartbeat request with a user-specified token.
 
Method Summary
 java.lang.String getUri()
          The URI to send the heartbeat request to.
 void setToken(java.lang.String token)
          Set the user specified token for the heartbeat.
 void writeTo(com.lmax.api.internal.xml.StructuredWriter writer)
          Internal: Output this request.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HeartbeatRequest

public HeartbeatRequest(java.lang.String token)
Create a heartbeat request with a user-specified token.

Parameters:
token - User specified token that will be echo back to the user.
Method Detail

setToken

public void setToken(java.lang.String token)
Set the user specified token for the heartbeat.

Parameters:
token - User specified token that will be echo back to the user.

getUri

public java.lang.String getUri()
The URI to send the heartbeat request to.

Specified by:
getUri in interface com.lmax.api.internal.Request
Returns:
The URI to send the heartbeat request to.

writeTo

public void writeTo(com.lmax.api.internal.xml.StructuredWriter writer)
Internal: Output this request.

Specified by:
writeTo in interface com.lmax.api.internal.Request
Parameters:
writer - The destination for the content of this request