velox.api.layer1.data

Class OrderCancelParameters

java.lang.Object

velox.api.layer1.data.OrderUpdateParameters

velox.api.layer1.data.OrderCancelParameters

public class OrderCancelParameters
extends OrderUpdateParameters

Used to cancel the order

Field Summary

Fields

Modifier and Type	Field and Description
boolean	batchEnd Marks end of batch.
long	batchId Orders with the same value will be attempted to be cancelled at once.
private static java.util.concurrent.atomic.AtomicLong	UNIQUE_BATCH_NUMBER_GENERATOR

Fields inherited from class velox.api.layer1.data.OrderUpdateParameters

orderId

Constructor Summary

Constructors

Constructor and Description
OrderCancelParameters(java.lang.String orderId) Request to cancel single order
OrderCancelParameters(java.lang.String orderId, boolean batchEnd) Request to cancel single order.
OrderCancelParameters(java.lang.String orderId, long batchId, boolean batchEnd)

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNIQUE_BATCH_NUMBER_GENERATOR

private static final java.util.concurrent.atomic.AtomicLong UNIQUE_BATCH_NUMBER_GENERATOR

batchId

public final long batchId

Orders with the same value will be attempted to be cancelled at once. This is a hint to provider that these requests are sent at once and optimizations can be applied. Some providers might skip redundant cancellations within batch.

batchEnd

public final boolean batchEnd

Marks end of batch. Failing to send this might indefinitely delay execution of batch.

Constructor Detail

OrderCancelParameters

public OrderCancelParameters(java.lang.String orderId)

Request to cancel single order

OrderCancelParameters

public OrderCancelParameters(java.lang.String orderId,
                             boolean batchEnd)

Request to cancel single order.

Parameters:

orderId - ID of the order to cancel.

batchEnd - If true it's a single order cancellation request. If false it's a start of new cancellation batch. Unique batch ID will be generated automatically.

OrderCancelParameters

public OrderCancelParameters(java.lang.String orderId,
                             long batchId,
                             boolean batchEnd)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class OrderUpdateParameters