KiteTicker (com.zerodhatech.kiteconnect:kiteconnect 3.2.1 API)

java.lang.Object
- com.zerodhatech.ticker.KiteTicker

```
public class KiteTicker
extends Object
```
Ticker provider sends tokens to com.zerodhatech.com.zerodhatech.ticker server and get ticks from com.zerodhatech.com.zerodhatech.ticker server. Ticker server sends data in bytes. This Class gets ticks and converts into readable format which includes our own business logic.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`BseCD`
`int`	`BseCM`
`int`	`BseFO`
`int`	`Indices`
`int`	`McxFO`
`int`	`McxSX`
`static String`	`modeFull`
`static String`	`modeLTP`
`static String`	`modeQuote`
`int`	`NseCD`
`int`	`NseCM`
`int`	`NseFO`

Constructor Summary

Constructors
Constructor and Description

KiteTicker(String accessToken, String apiKey)
Initialize Kite Ticker.

Constructors
Constructor and Description
`KiteTicker(String accessToken, String apiKey)` Initialize Kite Ticker.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`connect()` Establishes a web socket connection.
`void`	`disconnect()` Disconnects websocket connection.
`void`	`doReconnect()` Performs reconnection after a particular interval if count is less than maximum retries.
`Order`	`getOrder(org.json.JSONObject data)`
`com.neovisionaries.ws.client.WebSocketAdapter`	`getWebsocketAdapter()` Returns a WebSocketAdapter to listen to ticker related events.
`boolean`	`isConnectionOpen()` Returns true if websocket connection is open.
`void`	`setMaximumRetries(int maxRetries)` Set max number of retries for reconnection, for infinite retries set value as -1.
`void`	`setMaximumRetryInterval(int interval)`
`void`	`setMode(ArrayList<Long> tokens, String mode)` Setting different modes for an arraylist of tokens.
`void`	`setOnConnectedListener(OnConnect listener)` Set listener for on connection established.
`void`	`setOnDisconnectedListener(OnDisconnect listener)` Set listener for on connection is disconnected.
`void`	`setOnErrorListener(OnError listener)` Set error listener.
`void`	`setOnOrderUpdateListener(OnOrderUpdate listener)` Set listener for order updates.
`void`	`setOnTickerArrivalListener(OnTicks onTickerArrivalListener)` Set listener for listening to ticks.
`void`	`setTryReconnection(boolean retry)` Set tryReconnection, to instruct KiteTicker that it has to reconnect, if com.zerodhatech.ticker is disconnected.
`void`	`subscribe(ArrayList<Long> tokens)` Subscribes for list of tokens.
`void`	`unsubscribe(ArrayList<Long> tokens)` Unsubscribes ticks for list of tokens.

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

- Field Detail
  - NseCM
```
public final int NseCM
```
    See Also:
    
    Constant Field Values
  - NseFO
```
public final int NseFO
```
    See Also:
    
    Constant Field Values
  - NseCD
```
public final int NseCD
```
    See Also:
    
    Constant Field Values
  - BseCM
```
public final int BseCM
```
    See Also:
    
    Constant Field Values
  - BseFO
```
public final int BseFO
```
    See Also:
    
    Constant Field Values
  - BseCD
```
public final int BseCD
```
    See Also:
    
    Constant Field Values
  - McxFO
```
public final int McxFO
```
    See Also:
    
    Constant Field Values
  - McxSX
```
public final int McxSX
```
    See Also:
    
    Constant Field Values
  - Indices
```
public final int Indices
```
    See Also:
    
    Constant Field Values
  - modeFull
```
public static String modeFull
```
  - modeQuote
```
public static String modeQuote
```
  - modeLTP
```
public static String modeLTP
```
- Constructor Detail
  - KiteTicker
```
public KiteTicker(String accessToken,
                  String apiKey)
```
    Initialize Kite Ticker.
    
    Parameters:
    
    accessToken - is the token received after successful login process.
    
    apiKey - is the api key of the app which is received after creating an app on developers console.
- Method Detail
  - doReconnect
```
public void doReconnect()
```
    Performs reconnection after a particular interval if count is less than maximum retries.
  - setTryReconnection
```
public void setTryReconnection(boolean retry)
```
    Set tryReconnection, to instruct KiteTicker that it has to reconnect, if com.zerodhatech.ticker is disconnected.
    
    Parameters:
    
    retry - will denote whether reconnection should be tried or not.
  - setOnErrorListener
```
public void setOnErrorListener(OnError listener)
```
    Set error listener.
    
    Parameters:
    
    listener - of type OnError which listens to all the type of errors that may arise in Kite Ticker class.
  - setMaximumRetries
```
public void setMaximumRetries(int maxRetries)
                       throws KiteException
```
    Set max number of retries for reconnection, for infinite retries set value as -1.
    
    Parameters:
    
    maxRetries - denotes maximum number of retries that the com.zerodhatech.ticker can perform.
    
    Throws:
    
    KiteException - when maximum retries is less than 0.
  - setMaximumRetryInterval
```
public void setMaximumRetryInterval(int interval)
                             throws KiteException
```
    Throws:
    
    KiteException
  - setOnTickerArrivalListener
```
public void setOnTickerArrivalListener(OnTicks onTickerArrivalListener)
```
    Set listener for listening to ticks.
    
    Parameters:
    
    onTickerArrivalListener - is listener which listens for each tick.
  - setOnConnectedListener
```
public void setOnConnectedListener(OnConnect listener)
```
    Set listener for on connection established.
    
    Parameters:
    
    listener - is used to listen to onConnected event.
  - setOnDisconnectedListener
```
public void setOnDisconnectedListener(OnDisconnect listener)
```
    Set listener for on connection is disconnected.
    
    Parameters:
    
    listener - is used to listen to onDisconnected event.
  - setOnOrderUpdateListener
```
public void setOnOrderUpdateListener(OnOrderUpdate listener)
```
    Set listener for order updates.
    
    Parameters:
    
    listener - is used to listen to order updates.
  - connect
```
public void connect()
```
    Establishes a web socket connection.
  - getWebsocketAdapter
```
public com.neovisionaries.ws.client.WebSocketAdapter getWebsocketAdapter()
```
    Returns a WebSocketAdapter to listen to ticker related events.
  - disconnect
```
public void disconnect()
```
    Disconnects websocket connection.
  - isConnectionOpen
```
public boolean isConnectionOpen()
```
    Returns true if websocket connection is open.
    
    Returns:
    
    boolean
  - setMode
```
public void setMode(ArrayList<Long> tokens,
                    String mode)
```
    Setting different modes for an arraylist of tokens.
    
    Parameters:
    
    tokens - an arraylist of tokens
    
    mode - the mode that needs to be set. Scroll up to see different kind of modes
  - subscribe
```
public void subscribe(ArrayList<Long> tokens)
```
    Subscribes for list of tokens.
    
    Parameters:
    
    tokens - is list of tokens to be subscribed for.
  - unsubscribe
```
public void unsubscribe(ArrayList<Long> tokens)
```
    Unsubscribes ticks for list of tokens.
    
    Parameters:
    
    tokens - is the list of tokens that needs to be unsubscribed.
  - getOrder
```
public Order getOrder(org.json.JSONObject data)
```

Class KiteTicker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NseCM

NseFO

NseCD

BseCM

BseFO

BseCD

McxFO

McxSX

Indices

modeFull

modeQuote

modeLTP

Constructor Detail

KiteTicker

Method Detail

doReconnect

setTryReconnection

setOnErrorListener

setMaximumRetries

setMaximumRetryInterval

setOnTickerArrivalListener

setOnConnectedListener

setOnDisconnectedListener

setOnOrderUpdateListener

connect

getWebsocketAdapter

disconnect

isConnectionOpen

setMode

subscribe

unsubscribe

getOrder