Class: Quark::MdkProtocol::WSClient

Inherits:
DatawireQuarkCore::QuarkObject show all
Extended by:
DatawireQuarkCore::Static
Defined in:
lib/mdk_protocol.rb

Overview

Common protocol machinery for web socket based protocol clients.

Constant Summary

Constants included from DatawireQuarkCore::Static

DatawireQuarkCore::Static::Unassigned

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from DatawireQuarkCore::Static

_lazy_statics, static, unlazy_statics

Methods inherited from DatawireQuarkCore::QuarkObject

#to_s

Constructor Details

#initialize(runtime, parser, url, token) ⇒ WSClient

Returns a new instance of WSClient.



1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/mdk_protocol.rb', line 1303

def initialize(runtime, parser, url, token)
    
    self.__init_fields__
    (self).dispatcher = (runtime).dispatcher
    (self).timeService = runtime.getTimeService()
    (self).schedulingActor = runtime.getScheduleService()
    (self).websockets = runtime.getWebSocketsService()
    (self).url = url
    (self).token = token
    (self)._parser = parser

    nil
end

Instance Attribute Details

#_parser ⇒ Object

Returns the value of attribute _parser.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def _parser
  @_parser
end

#_started ⇒ Object

Returns the value of attribute _started.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def _started
  @_started
end

#dispatcher ⇒ Object

Returns the value of attribute dispatcher.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def dispatcher
  @dispatcher
end

#firstDelay ⇒ Object

Returns the value of attribute firstDelay.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def firstDelay
  @firstDelay
end

#lastConnectAttempt ⇒ Object

Returns the value of attribute lastConnectAttempt.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def lastConnectAttempt
  @lastConnectAttempt
end

#logger ⇒ Object

Returns the value of attribute logger.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def logger
  @logger
end

#maxDelay ⇒ Object

Returns the value of attribute maxDelay.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def maxDelay
  @maxDelay
end

#reconnectDelay ⇒ Object

Returns the value of attribute reconnectDelay.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def reconnectDelay
  @reconnectDelay
end

#schedulingActor ⇒ Object

Returns the value of attribute schedulingActor.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def schedulingActor
  @schedulingActor
end

#sock ⇒ Object

Returns the value of attribute sock.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def sock
  @sock
end

#subscribers ⇒ Object

Returns the value of attribute subscribers.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def subscribers
  @subscribers
end

#tick ⇒ Object

Returns the value of attribute tick.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def tick
  @tick
end

#timeService ⇒ Object

Returns the value of attribute timeService.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def timeService
  @timeService
end

#token ⇒ Object

Returns the value of attribute token.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def token
  @token
end

#ttl ⇒ Object

Returns the value of attribute ttl.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def ttl
  @ttl
end

#url ⇒ Object

Returns the value of attribute url.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def url
  @url
end

#websockets ⇒ Object

Returns the value of attribute websockets.



1295
1296
1297
 
# File 'lib/mdk_protocol.rb', line 1295

def websockets
  @websockets
end

Instance Method Details

#__init_fields__ ⇒ Object 



1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
 
# File 'lib/mdk_protocol.rb', line 1641

def __init_fields__()
    
    self.logger = ::Quark.quark._getLogger("protocol")
    self.firstDelay = 1.0
    self.maxDelay = 16.0
    self.reconnectDelay = @firstDelay
    self.ttl = 30.0
    self.tick = 1.0
    self.sock = nil
    self.lastConnectAttempt = 0
    self.timeService = nil
    self.schedulingActor = nil
    self.websockets = nil
    self.dispatcher = nil
    self.url = nil
    self.token = nil
    self.subscribers = ::DatawireQuarkCore::List.new([])
    self._started = false
    self._parser = nil

    nil
end

#_getClass ⇒ Object 



1519
1520
1521
1522
1523
1524
 
# File 'lib/mdk_protocol.rb', line 1519

def _getClass()
    
    return "mdk_protocol.WSClient"

    nil
end

#_getField(name) ⇒ Object 



1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
 
# File 'lib/mdk_protocol.rb', line 1526

def _getField(name)
    
    if ((name) == ("logger"))
        return (self).logger
    end
    if ((name) == ("firstDelay"))
        return (self).firstDelay
    end
    if ((name) == ("maxDelay"))
        return (self).maxDelay
    end
    if ((name) == ("reconnectDelay"))
        return (self).reconnectDelay
    end
    if ((name) == ("ttl"))
        return (self).ttl
    end
    if ((name) == ("tick"))
        return (self).tick
    end
    if ((name) == ("sock"))
        return (self).sock
    end
    if ((name) == ("lastConnectAttempt"))
        return (self).lastConnectAttempt
    end
    if ((name) == ("timeService"))
        return (self).timeService
    end
    if ((name) == ("schedulingActor"))
        return (self).schedulingActor
    end
    if ((name) == ("websockets"))
        return (self).websockets
    end
    if ((name) == ("dispatcher"))
        return (self).dispatcher
    end
    if ((name) == ("url"))
        return (self).url
    end
    if ((name) == ("token"))
        return (self).token
    end
    if ((name) == ("subscribers"))
        return (self).subscribers
    end
    if ((name) == ("_started"))
        return (self)._started
    end
    if ((name) == ("_parser"))
        return (self)._parser
    end
    return nil

    nil
end

#_setField(name, value) ⇒ Object 



1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'lib/mdk_protocol.rb', line 1584

def _setField(name, value)
    
    if ((name) == ("logger"))
        (self).logger = value
    end
    if ((name) == ("firstDelay"))
        (self).firstDelay = ::DatawireQuarkCore.cast(value) { ::Float }
    end
    if ((name) == ("maxDelay"))
        (self).maxDelay = ::DatawireQuarkCore.cast(value) { ::Float }
    end
    if ((name) == ("reconnectDelay"))
        (self).reconnectDelay = ::DatawireQuarkCore.cast(value) { ::Float }
    end
    if ((name) == ("ttl"))
        (self).ttl = ::DatawireQuarkCore.cast(value) { ::Float }
    end
    if ((name) == ("tick"))
        (self).tick = ::DatawireQuarkCore.cast(value) { ::Float }
    end
    if ((name) == ("sock"))
        (self).sock = ::DatawireQuarkCore.cast(value) { ::Quark.mdk_runtime.WSActor }
    end
    if ((name) == ("lastConnectAttempt"))
        (self).lastConnectAttempt = ::DatawireQuarkCore.cast(value) { ::Integer }
    end
    if ((name) == ("timeService"))
        (self).timeService = ::DatawireQuarkCore.cast(value) { ::Quark.mdk_runtime.Time }
    end
    if ((name) == ("schedulingActor"))
        (self).schedulingActor = ::DatawireQuarkCore.cast(value) { ::Quark.mdk_runtime.actors.Actor }
    end
    if ((name) == ("websockets"))
        (self).websockets = ::DatawireQuarkCore.cast(value) { ::Quark.mdk_runtime.WebSockets }
    end
    if ((name) == ("dispatcher"))
        (self).dispatcher = ::DatawireQuarkCore.cast(value) { ::Quark.mdk_runtime.actors.MessageDispatcher }
    end
    if ((name) == ("url"))
        (self).url = ::DatawireQuarkCore.cast(value) { ::String }
    end
    if ((name) == ("token"))
        (self).token = ::DatawireQuarkCore.cast(value) { ::String }
    end
    if ((name) == ("subscribers"))
        (self).subscribers = ::DatawireQuarkCore.cast(value) { ::DatawireQuarkCore::List }
    end
    if ((name) == ("_started"))
        (self)._started = ::DatawireQuarkCore.cast(value) { ::Object }
    end
    if ((name) == ("_parser"))
        (self)._parser = ::DatawireQuarkCore.cast(value) { ::Quark.mdk_protocol.JSONParser }
    end

    nil
end

#doBackoff ⇒ Object 



1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
 
# File 'lib/mdk_protocol.rb', line 1376

def doBackoff()
    
    @reconnectDelay = (2.0) * (@reconnectDelay)
    if ((@reconnectDelay) > (@maxDelay))
        @reconnectDelay = @maxDelay
    end
    @logger.info((("backing off, reconnecting in ") + ((@reconnectDelay).to_s)) + (" seconds"))

    nil
end

#doOpen ⇒ Object 



1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
 
# File 'lib/mdk_protocol.rb', line 1455

def doOpen()
    
    @lastConnectAttempt = (((self).timeService.time()) * (1000.0)).round()
    sockUrl = @url
    if ((@token) != (nil))
        sockUrl = ((sockUrl) + ("?token=")) + (@token)
    end
    @logger.info(("opening ") + (@url))
    (self).websockets.connect(sockUrl, self).andEither(::Quark.quark._BoundMethod.new(self, "onWSConnected", ::DatawireQuarkCore::List.new([])), ::Quark.quark._BoundMethod.new(self, "onWSError", ::DatawireQuarkCore::List.new([])))

    nil
end

#isConnected ⇒ Object 



1343
1344
1345
1346
1347
1348
 
# File 'lib/mdk_protocol.rb', line 1343

def isConnected()
    
    return (@sock) != (nil)

    nil
end

#isStarted ⇒ Object 



1336
1337
1338
1339
1340
1341
 
# File 'lib/mdk_protocol.rb', line 1336

def isStarted()
    
    return @_started

    nil
end

#onClose(error) ⇒ Object

Called when the connection is closed via message by the server.



1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'lib/mdk_protocol.rb', line 1367

def onClose(error)
    
    if ((error) != (nil))
        @logger.error(("Server closing connection due to error: ") + (error.toString()))
    end

    nil
end

#onMessage(origin, message) ⇒ Object 



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
 
# File 'lib/mdk_protocol.rb', line 1406

def onMessage(origin, message)
    
    typeId = (::Quark.quark.reflect.QuarkClass.get(::DatawireQuarkCore._getClass(message))).id
    if ((typeId) == ("mdk_runtime.Happening"))
        self.onScheduledEvent()
        return
    end
    if ((typeId) == ("mdk_runtime.WSClosed"))
        self.onWSClosed()
        return
    end
    if ((typeId) == ("mdk_runtime.WSMessage"))
        wsmessage = ::DatawireQuarkCore.cast(message) { ::Quark.mdk_runtime.WSMessage }
        parsed = (self)._parser.decode((wsmessage).body)
        if ((parsed) == (nil))
            return
        end
        decoded = ::Quark.mdk_protocol.DecodedMessage.new(parsed)
        idx = 0
        while ((idx) < (((self).subscribers).size)) do
            (self).dispatcher.tell(self, decoded, ((self).subscribers)[idx])
            idx = (idx) + (1)
        end
        return
    end

    nil
end

#onScheduledEvent ⇒ Object 



1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/mdk_protocol.rb', line 1435

def onScheduledEvent()
    
    rightNow = (((self).timeService.time()) * (1000.0)).round()
    reconnectInterval = ((@reconnectDelay) * (1000.0)).round()
    if (self.isConnected())
        if (self.isStarted())
            self.pump()
        end
    else
        if ((self.isStarted()) && (((rightNow) - (@lastConnectAttempt)) >= (reconnectInterval)))
            self.doOpen()
        end
    end
    if (self.isStarted())
        self.schedule(@tick)
    end

    nil
end

#onStart(dispatcher) ⇒ Object 



1387
1388
1389
1390
1391
1392
1393
 
# File 'lib/mdk_protocol.rb', line 1387

def onStart(dispatcher)
    
    (self)._started = true
    self.schedule(0.0)

    nil
end

#onStop ⇒ Object 



1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
 
# File 'lib/mdk_protocol.rb', line 1395

def onStop()
    
    (self)._started = false
    if (self.isConnected())
        (self).dispatcher.tell(self, ::Quark.mdk_runtime.WSClose.new(), @sock)
        @sock = ::DatawireQuarkCore.cast(nil) { ::Quark.mdk_runtime.WSActor }
    end

    nil
end

#onWSClosed ⇒ Object 



1511
1512
1513
1514
1515
1516
1517
 
# File 'lib/mdk_protocol.rb', line 1511

def onWSClosed()
    
    @logger.info(("closed ") + (@url))
    @sock = ::DatawireQuarkCore.cast(nil) { ::Quark.mdk_runtime.WSActor }

    nil
end

#onWSConnected(socket) ⇒ Object 



1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
 
# File 'lib/mdk_protocol.rb', line 1492

def onWSConnected(socket)
    
    @logger.info(((("connected to ") + (@url)) + (" via ")) + ((socket).to_s))
    @reconnectDelay = @firstDelay
    @sock = socket
    self.startup()
    self.pump()

    nil
end

#onWSError(error) ⇒ Object 



1503
1504
1505
1506
1507
1508
1509
 
# File 'lib/mdk_protocol.rb', line 1503

def onWSError(error)
    
    @logger.error(("onWSError in protocol! ") + (error.toString()))
    self.doBackoff()

    nil
end

#pump ⇒ Object 



1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
 
# File 'lib/mdk_protocol.rb', line 1480

def pump()
    
    message = ::Quark.mdk_protocol.Pump.new()
    idx = 0
    while ((idx) < ((@subscribers).size)) do
        (self).dispatcher.tell(self, message, (@subscribers)[idx])
        idx = (idx) + (1)
    end

    nil
end

#schedule(time) ⇒ Object 



1350
1351
1352
1353
1354
1355
 
# File 'lib/mdk_protocol.rb', line 1350

def schedule(time)
    
    (self).dispatcher.tell(self, ::Quark.mdk_runtime.Schedule.new("wakeup", time), (self).schedulingActor)

    nil
end

#scheduleReconnect ⇒ Object 



1357
1358
1359
1360
1361
1362
 
# File 'lib/mdk_protocol.rb', line 1357

def scheduleReconnect()
    
    self.schedule(@reconnectDelay)

    nil
end

#startup ⇒ Object 



1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
 
# File 'lib/mdk_protocol.rb', line 1468

def startup()
    
    message = ::Quark.mdk_protocol.WSConnected.new((self).sock)
    idx = 0
    while ((idx) < ((@subscribers).size)) do
        (self).dispatcher.tell(self, message, (@subscribers)[idx])
        idx = (idx) + (1)
    end

    nil
end

#subscribe(subscriber) ⇒ Object

Subscribe to messages from the server.

Do this before starting the WSClient.

The given Actor subscribes to WSConnected, all WSMessage received by the WSClient, as well as a periodic Pump message.



1329
1330
1331
1332
1333
1334
 
# File 'lib/mdk_protocol.rb', line 1329

def subscribe(subscriber)
    
    ((self).subscribers) << (subscriber)

    nil
end