Class: Bitmex::Base

Inherits:

Object

• Object
• Bitmex::Base

Defined in:

lib/bitmex/base.rb

Overview

Base class for all Bitmex models

Author:

• Iulian Costan

Direct Known Subclasses

Apikey, Chat, Instrument, Order, Position, Quote, Stats, Trade

Instance Attribute Summary

• #rest ⇒ Object readonly

  Returns the value of attribute rest.

• #websocket ⇒ Object readonly

  Returns the value of attribute websocket.

Instance Method Summary

• #initialize(rest, websocket = nil) ⇒ Base constructor

  A new instance of Base.

Constructor Details

#initialize(rest, websocket = nil) ⇒ Base

Returns a new instance of Base.

Parameters:

• rest (Bitmex::Rest) —

  the rest implementation

• websocket (Bitmex::Websocket) (defaults to: nil) —

  the websocket implementation

# File 'lib/bitmex/base.rb', line 9

def initialize(rest, websocket = nil)
  @rest = rest
  @websocket = websocket
end

Instance Attribute Details

#rest ⇒ Object (readonly)

Returns the value of attribute rest.

# File 'lib/bitmex/base.rb', line 5

def rest
  @rest
end

#websocket ⇒ Object (readonly)

Returns the value of attribute websocket.

# File 'lib/bitmex/base.rb', line 5

def websocket
  @websocket
end