3. API Documentation

3. API Documentation

The source code documentation of the public API of XCOFDK for Python is a comprehensive guide to the interfaces of the framework.

It is designed to serve as a single-sourced documentation of both the framework as a whole and its API through public subpackages of package xcofdk and related modules or classes, respectively. For an introductary walkthrough below source code components are recommended (in their given order):

• subpacakge xcofdk.fwapi:
  for start and stop of the framework,

• class xcofdk.fwapi.xtask.XTask:
  for basic concepts of the framework and its support for multithreading,

• class xcofdk.fwapi.xtask.XTaskError:
  for both life-cycle management and subsystem of error handling,

• class xcofdk.fwapi.xprocess.XProcess:
  for the subsystem of multiprocessing.

• class xcofdk.fwapi.xmsg.XMessageManager:
  for the subsystem of messaging,

• module xcofdk.fwcom.xlogif:
  for the subsystem of logging.

---

[Top] [Home] [Previous] [Next] - [1. Introduction] [2. Quick Start] [4. At a Glance] [5. Basic Examples]