summaryrefslogtreecommitdiff
path: root/python/qpid/management.py
blob: 83c29a78a5a75f45861ad848d393bd4fffd6130f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
#

"""
Management API for Qpid
"""

import qpid
import struct
import socket
from threading    import Thread
from datatypes    import Message, RangedSet
from time         import time
from cStringIO    import StringIO
from codec010     import StringCodec as Codec
from threading    import Lock, Condition


class SequenceManager:
  """ Manage sequence numbers for asynchronous method calls """
  def __init__ (self):
    self.lock     = Lock ()
    self.sequence = 0
    self.pending  = {}

  def reserve (self, data):
    """ Reserve a unique sequence number """
    self.lock.acquire ()
    result = self.sequence
    self.sequence = self.sequence + 1
    self.pending[result] = data
    self.lock.release ()
    return result

  def release (self, seq):
    """ Release a reserved sequence number """
    data = None
    self.lock.acquire ()
    if seq in self.pending:
      data = self.pending[seq]
      del self.pending[seq]
    self.lock.release ()
    return data


class mgmtObject (object):
  """ Generic object that holds the contents of a management object with its
      attributes set as object attributes. """

  def __init__ (self, classKey, timestamps, row):
    self.classKey   = classKey
    self.timestamps = timestamps
    for cell in row:
      setattr (self, cell[0], cell[1])

class methodResult:
  """ Object that contains the result of a method call """

  def __init__ (self, status, sText, args):
    self.status     = status
    self.statusText = sText
    for arg in args:
      setattr (self, arg, args[arg])

class brokerInfo:
  """ Object that contains information about a broker and the session to it """

  def __init__ (self, brokerId, sessionId):
    self.brokerId = brokerId
    self.sessionId = sessionId

class managementChannel:
  """ This class represents a connection to an AMQP broker. """

  def __init__ (self, ssn, topicCb, replyCb, exceptionCb, cbContext, _detlife=0):
    """ Given a channel on an established AMQP broker connection, this method
    opens a session and performs all of the declarations and bindings needed
    to participate in the management protocol. """
    self.enabled     = True
    self.ssn         = ssn
    self.sessionId   = ssn.name
    self.topicName   = "mgmt-%s" % self.sessionId
    self.replyName   = "repl-%s" % self.sessionId
    self.qpidChannel = ssn
    self.tcb         = topicCb
    self.rcb         = replyCb
    self.ecb         = exceptionCb
    self.context     = cbContext
    self.reqsOutstanding = 0
    self.brokerInfo  = None

    ssn.auto_sync = False
    ssn.queue_declare (queue=self.topicName, exclusive=True, auto_delete=True)
    ssn.queue_declare (queue=self.replyName, exclusive=True, auto_delete=True)

    ssn.exchange_bind (exchange="amq.direct",
                       queue=self.replyName, binding_key=self.replyName)
    ssn.message_subscribe (queue=self.topicName, destination="tdest")
    ssn.message_subscribe (queue=self.replyName, destination="rdest")

    ssn.incoming ("tdest").listen (self.topicCb, self.exceptionCb)
    ssn.incoming ("rdest").listen (self.replyCb)

    ssn.message_set_flow_mode (destination="tdest", flow_mode=1)
    ssn.message_flow (destination="tdest", unit=0, value=0xFFFFFFFF)
    ssn.message_flow (destination="tdest", unit=1, value=0xFFFFFFFF)

    ssn.message_set_flow_mode (destination="rdest", flow_mode=1)
    ssn.message_flow (destination="rdest", unit=0, value=0xFFFFFFFF)
    ssn.message_flow (destination="rdest", unit=1, value=0xFFFFFFFF)

  def setBrokerInfo (self, data):
    self.brokerInfo = data

  def shutdown (self):
    self.enabled = False
    self.ssn.incoming("tdest").stop()
    self.ssn.incoming("rdest").stop()

  def topicCb (self, msg):
    """ Receive messages via the topic queue on this channel. """
    if self.enabled:
      self.tcb (self, msg)

  def replyCb (self, msg):
    """ Receive messages via the reply queue on this channel. """
    if self.enabled:
      self.rcb (self, msg)

  def exceptionCb (self, data):
    if self.ecb != None:
      self.ecb (self, data)

  def send (self, exchange, msg):
    if self.enabled:
      self.qpidChannel.message_transfer (destination=exchange, message=msg)

  def accept (self, msg):
    self.qpidChannel.message_accept(RangedSet(msg.id))

  def message (self, body, routing_key="broker"):
    dp = self.qpidChannel.delivery_properties()
    dp.routing_key  = routing_key
    mp = self.qpidChannel.message_properties()
    mp.content_type = "application/octet-stream"
    mp.reply_to     = self.qpidChannel.reply_to("amq.direct", self.replyName)
    return Message(dp, mp, body)


class managementClient:
  """ This class provides an API for access to management data on the AMQP
  network.  It implements the management protocol and manages the management
  schemas as advertised by the various management agents in the network. """

  CTRL_BROKER_INFO   = 1
  CTRL_SCHEMA_LOADED = 2
  CTRL_USER          = 3
  CTRL_HEARTBEAT     = 4

  SYNC_TIME = 10.0

  #========================================================
  # User API - interacts with the class's user
  #========================================================
  def __init__ (self, amqpSpec, ctrlCb=None, configCb=None, instCb=None, methodCb=None, closeCb=None):
    self.spec     = amqpSpec
    self.ctrlCb   = ctrlCb
    self.configCb = configCb
    self.instCb   = instCb
    self.methodCb = methodCb
    self.closeCb  = closeCb
    self.schemaCb = None
    self.eventCb  = None
    self.channels = []
    self.seqMgr   = SequenceManager ()
    self.schema   = {}
    self.packages = {}
    self.cv       = Condition ()
    self.syncInFlight = False
    self.syncSequence = 0
    self.syncResult   = None

  def schemaListener (self, schemaCb):
    """ Optionally register a callback to receive details of the schema of
    managed objects in the network. """
    self.schemaCb = schemaCb

  def eventListener (self, eventCb):
    """ Optionally register a callback to receive events from managed objects
    in the network. """
    self.eventCb = eventCb

  def addChannel (self, channel, cbContext=None):
    """ Register a new channel. """
    mch = managementChannel (channel, self.topicCb, self.replyCb, self.exceptCb, cbContext)

    self.channels.append (mch)
    self.incOutstanding (mch)
    codec = Codec (self.spec)
    self.setHeader (codec, ord ('B'))
    msg = mch.message(codec.encoded)
    mch.send ("qpid.management", msg)
    return mch

  def removeChannel (self, mch):
    """ Remove a previously added channel from management. """
    mch.shutdown ()
    self.channels.remove (mch)

  def callMethod (self, channel, userSequence, objId, className, methodName, args=None):
    """ Invoke a method on a managed object. """
    self.method (channel, userSequence, objId, className, methodName, args)

  def getObjects (self, channel, userSequence, className, bank=0):
    """ Request immediate content from broker """
    codec = Codec (self.spec)
    self.setHeader (codec, ord ('G'), userSequence)
    ft = {}
    ft["_class"] = className
    codec.write_map (ft)
    msg = channel.message(codec.encoded, routing_key="agent.%d" % bank)
    channel.send ("qpid.management", msg)

  def syncWaitForStable (self, channel):
    """ Synchronous (blocking) call to wait for schema stability on a channel """
    self.cv.acquire ()
    if channel.reqsOutstanding == 0:
      self.cv.release ()
      return channel.brokerInfo

    self.syncInFlight = True
    starttime = time ()
    while channel.reqsOutstanding != 0:
      self.cv.wait (self.SYNC_TIME)
      if time () - starttime > self.SYNC_TIME:
        self.cv.release ()
        raise RuntimeError ("Timed out waiting for response on channel")
    self.cv.release ()
    return channel.brokerInfo

  def syncCallMethod (self, channel, objId, className, methodName, args=None):
    """ Synchronous (blocking) method call """
    self.cv.acquire ()
    self.syncInFlight = True
    self.syncResult   = None
    self.syncSequence = self.seqMgr.reserve ("sync")
    self.cv.release ()
    self.callMethod (channel, self.syncSequence, objId, className, methodName, args)
    self.cv.acquire ()
    starttime = time ()
    while self.syncInFlight:
      self.cv.wait (self.SYNC_TIME)
      if time () - starttime > self.SYNC_TIME:
        self.cv.release ()
        raise RuntimeError ("Timed out waiting for response on channel")
    result = self.syncResult
    self.cv.release ()
    return result

  def syncGetObjects (self, channel, className, bank=0):
    """ Synchronous (blocking) get call """
    self.cv.acquire ()
    self.syncInFlight = True
    self.syncResult   = []
    self.syncSequence = self.seqMgr.reserve ("sync")
    self.cv.release ()
    self.getObjects (channel, self.syncSequence, className, bank)
    self.cv.acquire ()
    starttime = time ()
    while self.syncInFlight:
      self.cv.wait (self.SYNC_TIME)
      if time () - starttime > self.SYNC_TIME:
        self.cv.release ()
        raise RuntimeError ("Timed out waiting for response on channel")
    result = self.syncResult
    self.cv.release ()
    return result

  #========================================================
  # Channel API - interacts with registered channel objects
  #========================================================
  def topicCb (self, ch, msg):
    """ Receive messages via the topic queue of a particular channel. """
    codec = Codec (self.spec, msg.body)
    hdr   = self.checkHeader (codec)
    if hdr == None:
      raise ValueError ("outer header invalid");

    if hdr[0] == 'p':
      self.handlePackageInd (ch, codec)
    elif hdr[0] == 'q':
      self.handleClassInd (ch, codec)
    elif hdr[0] == 'h':
      self.handleHeartbeat (ch, codec)
    else:
      self.parse (ch, codec, hdr[0], hdr[1])
    ch.accept(msg)

  def replyCb (self, ch, msg):
    """ Receive messages via the reply queue of a particular channel. """
    codec = Codec (self.spec, msg.body)
    hdr   = self.checkHeader (codec)
    if hdr == None:
      ch.accept(msg)
      return

    if   hdr[0] == 'm':
      self.handleMethodReply (ch, codec, hdr[1])
    elif hdr[0] == 'z':
      self.handleCommandComplete (ch, codec, hdr[1])
    elif hdr[0] == 'b':
      self.handleBrokerResponse (ch, codec)
    elif hdr[0] == 'p':
      self.handlePackageInd (ch, codec)
    elif hdr[0] == 'q':
      self.handleClassInd (ch, codec)
    else:
      self.parse (ch, codec, hdr[0], hdr[1])
    ch.accept(msg)

  def exceptCb (self, ch, data):
    if self.closeCb != None:
      self.closeCb (ch.context, data)

  #========================================================
  # Internal Functions
  #========================================================
  def setHeader (self, codec, opcode, seq = 0):
    """ Compose the header of a management message. """
    codec.write_uint8 (ord ('A'))
    codec.write_uint8 (ord ('M'))
    codec.write_uint8 (ord ('1'))
    codec.write_uint8 (opcode)
    codec.write_uint32  (seq)

  def checkHeader (self, codec):
    """ Check the header of a management message and extract the opcode and
    class. """
    octet = chr (codec.read_uint8 ())
    if octet != 'A':
      return None
    octet = chr (codec.read_uint8 ())
    if octet != 'M':
      return None
    octet = chr (codec.read_uint8 ())
    if octet != '1':
      return None
    opcode = chr (codec.read_uint8 ())
    seq    = codec.read_uint32 ()
    return (opcode, seq)

  def encodeValue (self, codec, value, typecode):
    """ Encode, into the codec, a value based on its typecode. """
    if   typecode == 1:
      codec.write_uint8  (int  (value))
    elif typecode == 2:
      codec.write_uint16 (int  (value))
    elif typecode == 3:
      codec.write_uint32 (long (value))
    elif typecode == 4:
      codec.write_uint64 (long (value))
    elif typecode == 5:
      codec.write_uint8  (int  (value))
    elif typecode == 6:
      codec.write_str8   (value)
    elif typecode == 7:
      codec.write_vbin32 (value)
    elif typecode == 8:  # ABSTIME
      codec.write_uint64 (long (value))
    elif typecode == 9:  # DELTATIME
      codec.write_uint64 (long (value))
    elif typecode == 10: # REF
      codec.write_uint64 (long (value))
    elif typecode == 11: # BOOL
      codec.write_uint8  (int  (value))
    elif typecode == 12: # FLOAT
      codec.write_float  (float (value))
    elif typecode == 13: # DOUBLE
      codec.write_double (double (value))
    elif typecode == 14: # UUID
      codec.write_uuid   (value)
    elif typecode == 15: # FTABLE
      codec.write_map    (value)
    elif typecode == 16:
      codec.write_int8 (int(value))
    elif typecode == 17:
      codec.write_int16 (int(value))
    elif typecode == 18:
      codec.write_int32 (int(value))
    elif typecode == 19:
      codec.write_int64 (int(value))
    else:
      raise ValueError ("Invalid type code: %d" % typecode)

  def decodeValue (self, codec, typecode):
    """ Decode, from the codec, a value based on its typecode. """
    if   typecode == 1:
      data = codec.read_uint8 ()
    elif typecode == 2:
      data = codec.read_uint16 ()
    elif typecode == 3:
      data = codec.read_uint32 ()
    elif typecode == 4:
      data = codec.read_uint64 ()
    elif typecode == 5:
      data = codec.read_uint8 ()
    elif typecode == 6:
      data = str (codec.read_str8 ())
    elif typecode == 7:
      data = codec.read_vbin32 ()
    elif typecode == 8:  # ABSTIME
      data = codec.read_uint64 ()
    elif typecode == 9:  # DELTATIME
      data = codec.read_uint64 ()
    elif typecode == 10: # REF
      data = codec.read_uint64 ()
    elif typecode == 11: # BOOL
      data = codec.read_uint8 ()
    elif typecode == 12: # FLOAT
      data = codec.read_float ()
    elif typecode == 13: # DOUBLE
      data = codec.read_double ()
    elif typecode == 14: # UUID
      data = codec.read_uuid ()
    elif typecode == 15: # FTABLE
      data = codec.read_map ()
    elif typecode == 16:
      data = codec.read_int8 ()
    elif typecode == 17:
      data = codec.read_int16 ()
    elif typecode == 18:
      data = codec.read_int32 ()
    elif typecode == 19:
      data = codec.read_int64 ()
    else:
      raise ValueError ("Invalid type code: %d" % typecode)
    return data

  def incOutstanding (self, ch):
    self.cv.acquire ()
    ch.reqsOutstanding = ch.reqsOutstanding + 1
    self.cv.release ()

  def decOutstanding (self, ch):
    self.cv.acquire ()
    ch.reqsOutstanding = ch.reqsOutstanding - 1
    if ch.reqsOutstanding == 0 and self.syncInFlight:
      self.syncInFlight = False
      self.cv.notify ()
    self.cv.release ()

    if ch.reqsOutstanding == 0:
      if self.ctrlCb != None:
        self.ctrlCb (ch.context, self.CTRL_SCHEMA_LOADED, None)
      ch.ssn.exchange_bind (exchange="qpid.management",
                            queue=ch.topicName, binding_key="mgmt.#")


  def handleMethodReply (self, ch, codec, sequence):
    status = codec.read_uint32 ()
    sText  = str (codec.read_str8 ())

    data = self.seqMgr.release (sequence)
    if data == None:
      return

    (userSequence, classId, methodName) = data
    args = {}
    context = self.seqMgr.release (userSequence)

    if status == 0:
      schemaClass = self.schema[classId]
      ms = schemaClass['M']
      arglist = None
      for mname in ms:
        (mdesc, margs) = ms[mname]
        if mname == methodName:
          arglist = margs
      if arglist == None:
        return

      for arg in arglist:
        if arg[2].find("O") != -1:
          args[arg[0]] = self.decodeValue (codec, arg[1])

    if context == "sync" and userSequence == self.syncSequence:
      self.cv.acquire ()
      self.syncInFlight = False
      self.syncResult   = methodResult (status, sText, args)
      self.cv.notify  ()
      self.cv.release ()
    elif self.methodCb != None:
      self.methodCb (ch.context, userSequence, status, sText, args)

  def handleCommandComplete (self, ch, codec, seq):
    code = codec.read_uint32 ()
    text = str (codec.read_str8 ())
    data = (seq, code, text)
    context = self.seqMgr.release (seq)
    if context == "outstanding":
      self.decOutstanding (ch)
    elif context == "sync" and seq == self.syncSequence:
      self.cv.acquire ()
      self.syncInFlight = False
      self.cv.notify  ()
      self.cv.release ()
    elif self.ctrlCb != None:
      self.ctrlCb (ch.context, self.CTRL_USER, data)

  def handleBrokerResponse (self, ch, codec):
    uuid = codec.read_uuid ()
    ch.brokerInfo = brokerInfo (uuid, ch.sessionId)
    if self.ctrlCb != None:
      self.ctrlCb (ch.context, self.CTRL_BROKER_INFO, ch.brokerInfo)

    # Send a package request
    sendCodec = Codec (self.spec)
    seq = self.seqMgr.reserve ("outstanding")
    self.setHeader (sendCodec, ord ('P'), seq)
    smsg = ch.message(sendCodec.encoded)
    ch.send ("qpid.management", smsg)

  def handlePackageInd (self, ch, codec):
    pname = str (codec.read_str8 ())
    if pname not in self.packages:
      self.packages[pname] = {}

      # Send a class request
      sendCodec = Codec (self.spec)
      seq = self.seqMgr.reserve ("outstanding")
      self.setHeader (sendCodec, ord ('Q'), seq)
      self.incOutstanding (ch)
      sendCodec.write_str8 (pname)
      smsg = ch.message(sendCodec.encoded)
      ch.send ("qpid.management", smsg)

  def handleClassInd (self, ch, codec):
    pname = str (codec.read_str8 ())
    cname = str (codec.read_str8 ())
    hash  = codec.read_bin128   ()
    if pname not in self.packages:
      return

    if (cname, hash) not in self.packages[pname]:
      # Send a schema request
      sendCodec = Codec (self.spec)
      seq = self.seqMgr.reserve ("outstanding")
      self.setHeader (sendCodec, ord ('S'), seq)
      self.incOutstanding (ch)
      sendCodec.write_str8 (pname)
      sendCodec.write_str8 (cname)
      sendCodec.write_bin128   (hash)
      smsg = ch.message(sendCodec.encoded)
      ch.send ("qpid.management", smsg)

  def handleHeartbeat (self, ch, codec):
    timestamp = codec.read_uint64()
    if self.ctrlCb != None:
      self.ctrlCb (ch.context, self.CTRL_HEARTBEAT, timestamp)

  def parseSchema (self, ch, codec):
    """ Parse a received schema-description message. """
    self.decOutstanding (ch)
    packageName = str (codec.read_str8 ())
    className   = str (codec.read_str8 ())
    hash        = codec.read_bin128 ()
    configCount = codec.read_uint16 ()
    instCount   = codec.read_uint16 ()
    methodCount = codec.read_uint16 ()
    eventCount  = codec.read_uint16 ()

    if packageName not in self.packages:
      return
    if (className, hash) in self.packages[packageName]:
      return

    classKey = (packageName, className, hash)
    if classKey in self.schema:
      return

    configs = []
    insts   = []
    methods = {}
    events  = []

    configs.append (("id", 4, "", "", 1, 1, None, None, None, None, None))
    insts.append   (("id", 4, None, None))

    for idx in range (configCount):
      ft = codec.read_map ()
      name   = str (ft["name"])
      type   = ft["type"]
      access = ft["access"]
      index  = ft["index"]
      unit   = None
      min    = None
      max    = None
      maxlen = None
      desc   = None

      for key, value in ft.items ():
        if   key == "unit":
          unit = str (value)
        elif key == "min":
          min = value
        elif key == "max":
          max = value
        elif key == "maxlen":
          maxlen = value
        elif key == "desc":
          desc = str (value)

      config = (name, type, unit, desc, access, index, min, max, maxlen)
      configs.append (config)

    for idx in range (instCount):
      ft = codec.read_map ()
      name   = str (ft["name"])
      type   = ft["type"]
      unit   = None
      desc   = None

      for key, value in ft.items ():
        if   key == "unit":
          unit = str (value)
        elif key == "desc":
          desc = str (value)

      inst = (name, type, unit, desc)
      insts.append (inst)

    for idx in range (methodCount):
      ft = codec.read_map ()
      mname    = str (ft["name"])
      argCount = ft["argCount"]
      if "desc" in ft:
        mdesc = str (ft["desc"])
      else:
        mdesc = None

      args = []
      for aidx in range (argCount):
        ft = codec.read_map ()
        name    = str (ft["name"])
        type    = ft["type"]
        dir     = str (ft["dir"].upper ())
        unit    = None
        min     = None
        max     = None
        maxlen  = None
        desc    = None
        default = None

        for key, value in ft.items ():
          if   key == "unit":
            unit = str (value)
          elif key == "min":
            min = value
          elif key == "max":
            max = value
          elif key == "maxlen":
            maxlen = value
          elif key == "desc":
            desc = str (value)
          elif key == "default":
            default = str (value)

        arg = (name, type, dir, unit, desc, min, max, maxlen, default)
        args.append (arg)
      methods[mname] = (mdesc, args)

    schemaClass = {}
    schemaClass['C'] = configs
    schemaClass['I'] = insts
    schemaClass['M'] = methods
    schemaClass['E'] = events
    self.schema[classKey] = schemaClass

    if self.schemaCb != None:
      self.schemaCb (ch.context, classKey, configs, insts, methods, events)

  def parseContent (self, ch, cls, codec, seq=0):
    """ Parse a received content message. """
    if (cls == 'C' or (cls == 'B' and seq == 0)) and self.configCb == None:
      return
    if cls == 'I' and self.instCb == None:
      return

    packageName = str (codec.read_str8 ())
    className   = str (codec.read_str8 ())
    hash        = codec.read_bin128 ()
    classKey    = (packageName, className, hash)

    if classKey not in self.schema:
      return

    row        = []
    timestamps = []

    timestamps.append (codec.read_uint64 ())  # Current Time
    timestamps.append (codec.read_uint64 ())  # Create Time
    timestamps.append (codec.read_uint64 ())  # Delete Time

    schemaClass = self.schema[classKey]
    if cls == 'C' or cls == 'B':
      for element in schemaClass['C'][:]:
        tc   = element[1]
        name = element[0]
        data = self.decodeValue (codec, tc)
        row.append ((name, data))

    if cls == 'I' or cls == 'B':
      if cls == 'B':
        start = 1
      else:
        start = 0
      for element in schemaClass['I'][start:]:
        tc   = element[1]
        name = element[0]
        data = self.decodeValue (codec, tc)
        row.append ((name, data))

    if   cls == 'C' or (cls == 'B' and seq != self.syncSequence):
      self.configCb (ch.context, classKey, row, timestamps)
    elif cls == 'B' and seq == self.syncSequence:
      if timestamps[2] == 0:
        obj = mgmtObject (classKey, timestamps, row)
        self.syncResult.append (obj)
    elif cls == 'I':
      self.instCb   (ch.context, classKey, row, timestamps)

  def parse (self, ch, codec, opcode, seq):
    """ Parse a message received from the topic queue. """
    if opcode   == 's':
      self.parseSchema  (ch, codec)
    elif opcode == 'c':
      self.parseContent (ch, 'C', codec)
    elif opcode == 'i':
      self.parseContent (ch, 'I', codec)
    elif opcode == 'g':
      self.parseContent (ch, 'B', codec, seq)
    else:
      raise ValueError ("Unknown opcode: %c" % opcode);

  def method (self, channel, userSequence, objId, classId, methodName, args):
    """ Invoke a method on an object """
    codec = Codec (self.spec)
    sequence = self.seqMgr.reserve ((userSequence, classId, methodName))
    self.setHeader (codec, ord ('M'), sequence)
    codec.write_uint64 (objId)       # ID of object
    codec.write_str8 (methodName)
    bank = (objId & 0x0000FFFFFF000000) >> 24

    # Encode args according to schema
    if classId not in self.schema:
      self.seqMgr.release (sequence)
      raise ValueError ("Unknown class name: %s" % classId)
    
    schemaClass = self.schema[classId]
    ms          = schemaClass['M']
    arglist     = None
    for mname in ms:
      (mdesc, margs) = ms[mname]
      if mname == methodName:
        arglist = margs
    if arglist == None:
      self.seqMgr.release (sequence)
      raise ValueError ("Unknown method name: %s" % methodName)

    for arg in arglist:
      if arg[2].find("I") != -1:
        value = arg[8]  # default
        if arg[0] in args:
          value = args[arg[0]]
          if value == None:
            self.seqMgr.release (sequence)
            raise ValueError ("Missing non-defaulted argument: %s" % arg[0])
          self.encodeValue (codec, value, arg[1])

    packageName = classId[0]
    className   = classId[1]
    msg = channel.message(codec.encoded, "agent." + str(bank))
    channel.send ("qpid.management", msg)