kiteticker

Documentation

Overview

Package kiteticker provides kite ticker access using callbacks.

Index

• Constants
• type Mode
• type Ticker
  • func New(apiKey string, accessToken string) *Ticker
  • func (t *Ticker) Close() error
  • func (t *Ticker) OnClose(f func(code int, reason string))
  • func (t *Ticker) OnConnect(f func())
  • func (t *Ticker) OnError(f func(err error))
  • func (t *Ticker) OnMessage(f func(messageType int, message []byte))
  • func (t *Ticker) OnNoReconnect(f func(attempt int))
  • func (t *Ticker) OnOrderUpdate(f func(order kiteconnect.Order))
  • func (t *Ticker) OnReconnect(f func(attempt int, delay time.Duration))
  • func (t *Ticker) OnTick(f func(tick models.Tick))
  • func (t *Ticker) Resubscribe() error
  • func (t *Ticker) Serve()
  • func (t *Ticker) ServeWithContext(ctx context.Context)
  • func (t *Ticker) SetAccessToken(aToken string)
  • func (t *Ticker) SetAutoReconnect(val bool)
  • func (t *Ticker) SetConnectTimeout(val time.Duration)
  • func (t *Ticker) SetMode(mode Mode, tokens []uint32) error
  • func (t *Ticker) SetReconnectMaxDelay(val time.Duration) error
  • func (t *Ticker) SetReconnectMaxRetries(val int)
  • func (t *Ticker) SetRootURL(u url.URL)
  • func (t *Ticker) Stop()
  • func (t *Ticker) Subscribe(tokens []uint32) error
  • func (t *Ticker) Unsubscribe(tokens []uint32) error

Constants

const (
	// Segment constants.
	NseCM = 1 + iota
	NseFO
	NseCD
	BseCM
	BseFO
	BseCD
	McxFO
	McxSX
	Indices

	// ModeLTP subscribes for last price.
	ModeLTP Mode = "ltp"
	// ModeFull subscribes for all the available fields.
	ModeFull Mode = "full"
	// ModeQuote represents quote mode.
	ModeQuote Mode = "quote"

	// TextMessage denotes a text data message. The text message payload is
	// interpreted as UTF-8 encoded text data.
	TextMessage = 1

	// BinaryMessage denotes a binary data message.
	BinaryMessage = 2

	// CloseMessage denotes a close control message. The optional message
	// payload contains a numeric code and text. Use the FormatCloseMessage
	// function to format a close message payload.
	CloseMessage = 8

	// PingMessage denotes a ping control message. The optional message payload
	// is UTF-8 encoded text.
	PingMessage = 9

	// PongMessage denotes a ping control message. The optional message payload
	// is UTF-8 encoded text.
	PongMessage = 10
)

Types

type Mode

type Mode string

Mode represents available ticker modes.

type Ticker

type Ticker struct {
	Conn *websocket.Conn
	// contains filtered or unexported fields
}

Ticker is a Kite connect ticker instance.

func New

func New(apiKey string, accessToken string) *Ticker

New creates a new ticker instance.

func (*Ticker) Close

func (t *Ticker) Close() error

Close tries to close the connection gracefully. If the server doesn't close it

func (*Ticker) OnClose

func (t *Ticker) OnClose(f func(code int, reason string))

OnClose callback.

func (*Ticker) OnConnect

func (t *Ticker) OnConnect(f func())

OnConnect callback.

func (*Ticker) OnError

func (t *Ticker) OnError(f func(err error))

OnError callback.

func (*Ticker) OnMessage

func (t *Ticker) OnMessage(f func(messageType int, message []byte))

OnMessage callback.

func (*Ticker) OnNoReconnect

func (t *Ticker) OnNoReconnect(f func(attempt int))

OnNoReconnect callback.

func (*Ticker) OnOrderUpdate

func (t *Ticker) OnOrderUpdate(f func(order kiteconnect.Order))

OnOrderUpdate callback.

func (*Ticker) OnReconnect

func (t *Ticker) OnReconnect(f func(attempt int, delay time.Duration))

OnReconnect callback.

func (*Ticker) OnTick

func (t *Ticker) OnTick(f func(tick models.Tick))

OnTick callback.

func (*Ticker) Resubscribe

func (t *Ticker) Resubscribe() error

Resubscribe resubscribes to the current stored subscriptions

func (*Ticker) Serve

func (t *Ticker) Serve()

Serve starts the connection to ticker server. Since its blocking its recommended to use it in a go routine.

func (*Ticker) ServeWithContext

func (t *Ticker) ServeWithContext(ctx context.Context)

ServeWithContext starts the connection to ticker server and additionally accepts a context. Since its blocking its recommended to use it in a go routine.

func (*Ticker) SetAccessToken

func (t *Ticker) SetAccessToken(aToken string)

SetAccessToken set access token.

func (*Ticker) SetAutoReconnect

func (t *Ticker) SetAutoReconnect(val bool)

SetAutoReconnect enable/disable auto reconnect.

func (*Ticker) SetConnectTimeout

func (t *Ticker) SetConnectTimeout(val time.Duration)

SetConnectTimeout sets default timeout for initial connect handshake

func (*Ticker) SetMode

func (t *Ticker) SetMode(mode Mode, tokens []uint32) error

SetMode changes mode for given list of tokens and mode.

func (*Ticker) SetReconnectMaxDelay

func (t *Ticker) SetReconnectMaxDelay(val time.Duration) error

SetReconnectMaxDelay sets maximum auto reconnect delay.

func (*Ticker) SetReconnectMaxRetries

func (t *Ticker) SetReconnectMaxRetries(val int)

SetReconnectMaxRetries sets maximum reconnect attempts.

func (*Ticker) SetRootURL

func (t *Ticker) SetRootURL(u url.URL)

SetRootURL sets ticker root url.

func (*Ticker) Stop

func (t *Ticker) Stop()

Stop the ticker instance and all the goroutines it has spawned.

func (*Ticker) Subscribe

func (t *Ticker) Subscribe(tokens []uint32) error

Subscribe subscribes tick for the given list of tokens.

func (*Ticker) Unsubscribe

func (t *Ticker) Unsubscribe(tokens []uint32) error

Unsubscribe unsubscribes tick for the given list of tokens.