Project Task Page: Axon ThreadedComponent termination bugfix

Status: Completed
Current Developers: MH, MPS
Current "inflight" dev location: /branches/private_MH_20070522_threadedcomponent_bugfixes
Start Date: 22 May 2007
End Date: 5 Aug 2007
Date this page last updated: 5 Aug 2007
Estimated effort so far: 1 day

Description


Casual inspection of Axon.ThreadedComponent identified a bug:threadedcomponent may never properly terminate if, when the thread (main() method) terminates, one of the inqueues in full and there are still messages waiting at the corresponding inbox.

This branch adds test suite coverage of this issues and fixes the bug.

Inputs

This section is largely about WHO has influenced this task to do WHAT, and where possible WHY. It is also about WHO to contact with regard to this task to influence what's going on.
  • Task Sponsor: MH
  • Task Owner: MH
  • Developers involved: MH (development)
  • Users: MH, Patrick`
  • Interested third parties: MH, Patrick`
  • Requirements
    • MUST fix the bug!
    • SHOULD not cause any regressions
    • MUST have some test suite coverage to catch the bug if it arises again in future

Outputs

Expected

  • Modifications to Axon (initially in branch then merged into mainline code)
  • ...including modifications and additions to the Axon test suite

Actual

  • Code:
    • SVN branch: private_MH_20070522_threadedcomponent_bugfixes
    • Mainline code: /Code/Python/Axon/Axon/
      • Modified: ThreadedComponent.py
    • Mainline code: /Tests/Python/Axon/
      • Modified: test_ThreadedComponent.py

Realistic possibilities arising as a result of activity on this task

none

Related Tasks

Tasks that directly enable this task (dependencies)

  • none

Sub Tasks

  • Development
  • Testing
  • Test suite additions

Task Log

  • 22 May 2007 : Added developer Matt
  • 22 May 2007 : Task status changed to running.
  • 22 May 2007 : Matt : working on private_MH_20070522_threadedcomponent_bugfixes branch
  • 23 May 2007 : Matt : bulk of development and tests complete. Days spent: 1.0
  • 23 May 2007 : Matt : branch ready for merge
  • 1 Aug 2007: MPS : merged

Discussion

To my mind this could be deemed a bugfix. It is certainly not really a tangible API or feature-set change.

I've added to the docstrings to provide clarification around shutdown behaviour to people writing threaded components. Its basically documenting the situation as-is, rather than being a change in behaviour (aside from the bugfix aspect!)

-- Matt Hammond, 23 May 2007


 

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)