| <!DOCTYPE html> |
| <html lang="en" dir="ltr" class="client-nojs"> |
| <head> |
| <meta charset="UTF-8" /> |
| <title>SMILA/Documentation/WorkerManager - Eclipsepedia</title> |
| <meta http-equiv="X-UA-Compatible" content="IE=EDGE" /> |
| <meta name="generator" content="MediaWiki 1.23.2" /> |
| <link rel="shortcut icon" href="http://wiki.eclipse.org/eclipse.org-common/themes/solstice/public/images/favicon.ico" /> |
| <link rel="search" type="application/opensearchdescription+xml" href="http://wiki.eclipse.org/opensearch_desc.php" title="Eclipsepedia (en)" /> |
| <link rel="EditURI" type="application/rsd+xml" href="http://wiki.eclipse.org/api.php?action=rsd" /> |
| <link rel="alternate" type="application/atom+xml" title="Eclipsepedia Atom feed" href="http://wiki.eclipse.org/index.php?title=Special:RecentChanges&feed=atom" /> |
| <link rel="stylesheet" href="http://wiki.eclipse.org/load.php?debug=false&lang=en&modules=mediawiki.legacy.commonPrint%2Cshared%7Cmediawiki.ui.button&only=styles&skin=solstice&*" /> |
| <link rel="stylesheet" href="http://wiki.eclipse.org/skins/solstice/public/stylesheets/styles.min.css?303" media="screen, print" /><meta name="ResourceLoaderDynamicStyles" content="" /> |
| <style>a:lang(ar),a:lang(kk-arab),a:lang(mzn),a:lang(ps),a:lang(ur){text-decoration:none} |
| /* cache key: my_wiki:resourceloader:filter:minify-css:7:14ece53a42aa314864e5fd8c57f0d98f */</style> |
| <script src="http://wiki.eclipse.org/load.php?debug=false&lang=en&modules=startup&only=scripts&skin=solstice&*"></script> |
| <script>if(window.mw){ |
| mw.config.set({"wgCanonicalNamespace":"","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":0,"wgPageName":"SMILA/Documentation/WorkerManager","wgTitle":"SMILA/Documentation/WorkerManager","wgCurRevisionId":325818,"wgRevisionId":325818,"wgArticleId":32488,"wgIsArticle":true,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":[],"wgBreakFrames":false,"wgPageContentLanguage":"en","wgPageContentModel":"wikitext","wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy","wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgMonthNamesShort":["","Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],"wgRelevantPageName":"SMILA/Documentation/WorkerManager","wgIsProbablyEditable":false,"wgRestrictionEdit":[],"wgRestrictionMove":[],"wgWikiEditorEnabledModules":{"toolbar":false,"dialogs":false,"hidesig":true,"preview":false,"previewDialog":false,"publish":false},"wgCategoryTreePageCategoryOptions":"{\"mode\":0,\"hideprefix\":20,\"showcount\":true,\"namespaces\":false}"}); |
| }</script><script>if(window.mw){ |
| mw.loader.implement("user.options",function($,jQuery){mw.user.options.set({"ccmeonemails":0,"cols":80,"date":"default","diffonly":0,"disablemail":0,"editfont":"default","editondblclick":0,"editsectiononrightclick":0,"enotifminoredits":0,"enotifrevealaddr":0,"enotifusertalkpages":1,"enotifwatchlistpages":1,"extendwatchlist":0,"fancysig":0,"forceeditsummary":0,"gender":"unknown","hideminor":0,"hidepatrolled":0,"imagesize":2,"math":1,"minordefault":0,"newpageshidepatrolled":0,"nickname":"","norollbackdiff":0,"numberheadings":0,"previewonfirst":0,"previewontop":1,"rcdays":7,"rclimit":50,"rows":25,"showhiddencats":0,"shownumberswatching":1,"showtoolbar":1,"skin":"solstice","stubthreshold":0,"thumbsize":2,"underline":2,"uselivepreview":0,"usenewrc":0,"watchcreations":1,"watchdefault":1,"watchdeletion":0,"watchlistdays":3,"watchlisthideanons":0,"watchlisthidebots":0,"watchlisthideliu":0,"watchlisthideminor":0,"watchlisthideown":0,"watchlisthidepatrolled":0,"watchmoves":0,"wllimit":250, |
| "useeditwarning":1,"prefershttps":1,"language":"en","variant-gan":"gan","variant-iu":"iu","variant-kk":"kk","variant-ku":"ku","variant-shi":"shi","variant-sr":"sr","variant-tg":"tg","variant-uz":"uz","variant-zh":"zh","searchNs0":true,"searchNs1":false,"searchNs2":false,"searchNs3":false,"searchNs4":false,"searchNs5":false,"searchNs6":false,"searchNs7":false,"searchNs8":false,"searchNs9":false,"searchNs10":false,"searchNs11":false,"searchNs12":false,"searchNs13":false,"searchNs14":false,"searchNs15":false,"variant":"en"});},{},{});mw.loader.implement("user.tokens",function($,jQuery){mw.user.tokens.set({"editToken":"+\\","patrolToken":false,"watchToken":false});},{},{}); |
| /* cache key: my_wiki:resourceloader:filter:minify-js:7:70d74423d3fc1e1c18fa9a1ff645a84a */ |
| }</script> |
| <script>if(window.mw){ |
| mw.loader.load(["mediawiki.page.startup","mediawiki.legacy.wikibits","mediawiki.legacy.ajax"]); |
| }</script> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"></head> |
| <body class="mediawiki ltr sitedir-ltr ns-0 ns-subject page-SMILA_Documentation_WorkerManager skin-solstice action-view" id="solstice"> |
| <a class="sr-only" href="WorkerManager.html#content">Skip to main content</a> |
| <div class="thin-header"> |
| <header role="banner" class="hidden-print noprint"> |
| <div class="container-fluid"> |
| <div id="row-logo-search"> |
| <div id="header-left"> |
| <div class="row"> |
| <div class="hidden-xs col-sm-6 logo-container"> |
| <a href="https://www.eclipse.org/" ><img class="logo-eclipse-default" src="http://wiki.eclipse.org/skins/solstice/public/images/logo/eclipse-800x188.png" alt="Eclipsepedia"></a> |
| </div> |
| <div class="navbar col-sm-18 yamm" id="main-menu"> |
| <div class="navbar-collapse collapse" id="navbar-collapse-1"> |
| <ul class="nav navbar-nav"> |
| <li><a target="_self" href="https://eclipse.org/downloads/">Download</a></li> |
| <li><a target="_self" href="https://eclipse.org/users/">Getting Started </a></li> |
| <li><a target="_self" href="https://eclipse.org/membership/">Members</a></li> |
| <li><a target="_self" href="https://eclipse.org/projects/">Projects</a></li> |
| <li class="dropdown visible-xs"><a class="dropdown-toggle" data-toggle="dropdown" href="WorkerManager.html#">Community <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="http://marketplace.eclipse.org">Marketplace</a></li><li><a href="http://events.eclipse.org">Events</a></li><li><a href="http://www.planeteclipse.org/">Planet Eclipse</a></li><li><a href="https://eclipse.org/community/eclipse_newsletter/">Newsletter</a></li><li><a href="https://www.youtube.com/user/EclipseFdn">Videos</a></li></ul></li><li class="dropdown visible-xs"><a class="dropdown-toggle" data-toggle="dropdown" href="WorkerManager.html#">Participate <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="https://bugs.eclipse.org/bugs/">Report a Bug</a></li><li><a href="https://eclipse.org/forums/">Forums</a></li><li><a href="https://eclipse.org/mail/">Mailing Lists</a></li><li><a href="https://wiki.eclipse.org/">Wiki</a></li><li><a href="https://wiki.eclipse.org/IRC">IRC</a></li><li><a href="https://eclipse.org/contribute/">How to Contribute</a></li></ul></li><li class="dropdown visible-xs"><a class="dropdown-toggle" data-toggle="dropdown" href="WorkerManager.html#">Working Groups <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="http://wiki.eclipse.org/Auto_IWG">Automotive</a></li><li><a href="http://iot.eclipse.org">Internet of Things</a></li><li><a href="http://locationtech.org">LocationTech</a></li><li><a href="http://lts.eclipse.org">Long-Term Support</a></li><li><a href="http://polarsys.org">PolarSys</a></li><li><a href="http://science.eclipse.org">Science</a></li><li><a href="http://openmdm.org">OpenMDM</a></li></ul></li><!-- More --> |
| <li class="dropdown hidden-xs"><a class="dropdown-toggle" data-toggle="dropdown">More<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li> |
| <!-- Content container to add padding --> |
| <div class="yamm-content"> |
| <div class="row"> |
| <ul class="col-sm-8 list-unstyled"><li><p><strong>Community</strong></p></li><li><a href="http://marketplace.eclipse.org">Marketplace</a></li><li><a href="http://events.eclipse.org">Events</a></li><li><a href="http://www.planeteclipse.org/">Planet Eclipse</a></li><li><a href="https://eclipse.org/community/eclipse_newsletter/">Newsletter</a></li><li><a href="https://www.youtube.com/user/EclipseFdn">Videos</a></li></ul><ul class="col-sm-8 list-unstyled"><li><p><strong>Participate</strong></p></li><li><a href="https://bugs.eclipse.org/bugs/">Report a Bug</a></li><li><a href="https://eclipse.org/forums/">Forums</a></li><li><a href="https://eclipse.org/mail/">Mailing Lists</a></li><li><a href="https://wiki.eclipse.org/">Wiki</a></li><li><a href="https://wiki.eclipse.org/IRC">IRC</a></li><li><a href="https://eclipse.org/contribute/">How to Contribute</a></li></ul><ul class="col-sm-8 list-unstyled"><li><p><strong>Working Groups</strong></p></li><li><a href="http://wiki.eclipse.org/Auto_IWG">Automotive</a></li><li><a href="http://iot.eclipse.org">Internet of Things</a></li><li><a href="http://locationtech.org">LocationTech</a></li><li><a href="http://lts.eclipse.org">Long-Term Support</a></li><li><a href="http://polarsys.org">PolarSys</a></li><li><a href="http://science.eclipse.org">Science</a></li><li><a href="http://openmdm.org">OpenMDM</a></li></ul> </div> |
| </div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="navbar-header"> |
| <button data-target="#navbar-collapse-1" data-toggle="collapse" class="navbar-toggle" type="button"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a href="https://www.eclipse.org/" class="visible-xs navbar-brand"><img class="logo-eclipse-default" src="http://wiki.eclipse.org/skins/solstice/public/images/logo/eclipse-800x188.png" alt="Eclipsepedia" width="174"></a> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </header> |
| <section class="defaut-breadcrumbs hidden-print noprint hidden-print clearfix" id="breadcrumb"> |
| <div> |
| <ol class="breadcrumb"> |
| <li><a href="https://www.eclipse.org/">Home</a></li> |
| <li><a href="http://wiki.eclipse.org/Main_Page">Eclipse Wiki</a></li> |
| <li class="active">SMILA/Documentation/WorkerManager</li></ol> |
| </div> |
| </section> |
| </div> |
| <div class="toolbar-menu breadcrumbs-offset noprint hidden-print margin-bottom-0 clearfix"> |
| <div class="col-md-24"> |
| <ol class="breadcrumb" role="navigation"> |
| <li id="pt-login"> |
| <a href="http://wiki.eclipse.org/index.php?title=Special:UserLogin&returnto=SMILA%2FDocumentation%2FWorkerManager"> |
| <i class="fa fa-sign-in fa-fw orange"></i> Log in </a> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <main role="main" class="background-grey"> |
| <div class="container-full padding-top-25"> |
| |
| |
| |
| <!-- content --> |
| <section id="content" class="mw-body container-full clearfix 0"> |
| <div id="mw-js-message" style="display:none;"></div> |
| |
| |
| <!-- bodyContent --> |
| <div id="bodyContent"> |
| |
| |
| <!-- jumpto --> |
| <div id="jump-to-nav" class="mw-jump"> |
| Jump to: <a href="WorkerManager.html#mw-head">navigation</a>, |
| <a href="WorkerManager.html#p-search">search</a> |
| </div> |
| <!-- /jumpto --> |
| |
| <!-- leftcol --> |
| <aside class="col-md-4 noprint hidden-print" id="leftcol"> |
| <form class="input-group" role="form" id="form-eclipse-search" action="http://wiki.eclipse.org/index.php" id="searchform"> |
| <input id="searchInput" class="search-query form-control" type="search" accesskey="f" title="Special:Search" placeholder="Search" name="search" value=""> |
| |
| <span class="input-group-btn"> |
| <button value="search" id="mw-searchButton" type="submit" class="btn btn-default" title="Search the pages for this text" name="fulltext"> |
| <i class="fa fa-search"></i> |
| </button> |
| </span> |
| </form> |
| <select class="form-control margin-top-10 margin-bottom-10 visible-xs visible-sm" onchange="this.options[this.selectedIndex].value && (window.location = this.options[this.selectedIndex].value);"><option class="fw-700 "><span class="fw-700">---Navigation---</span></option><option value="/Main_Page">Main Page</option><option value="/Eclipsepedia:Community_portal">Community portal</option><option value="/Eclipsepedia:Current_events">Current events</option><option value="/Special:RecentChanges">Recent changes</option><option value="/Special:Random">Random page</option><option value="https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents">Help</option></select><ul class="ul-left-nav fa-ul hidden-print leftnav hidden-xs hidden-sm"><li class="separator"><span class="separator">Navigation</span></li> <li class=""><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="http://wiki.eclipse.org/Main_Page" id="n-mainpage" title="Visit the main page [z]" accesskey="z">Main Page</a></li> <li class=""><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="http://wiki.eclipse.org/Eclipsepedia:Community_portal" id="n-portal" title="About the project, what you can do, where to find things">Community portal</a></li> <li class=""><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="http://wiki.eclipse.org/Eclipsepedia:Current_events" id="n-currentevents" title="Find background information on current events">Current events</a></li> <li class=""><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="http://wiki.eclipse.org/Special:RecentChanges" id="n-recentchanges" title="A list of recent changes in the wiki [r]" accesskey="r">Recent changes</a></li> <li class=""><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="http://wiki.eclipse.org/Special:Random" id="n-randompage" title="Load a random page [x]" accesskey="x">Random page</a></li> <li class=""><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents" id="n-help" title="The place to find out">Help</a></li></ul> <select class="form-control margin-top-10 margin-bottom-10 visible-xs visible-sm" onchange="this.options[this.selectedIndex].value && (window.location = this.options[this.selectedIndex].value);"><option class="fw-700 "><span class="fw-700">---Toolbox---</span></option><option value="/index.php?title=SMILA/Documentation/WorkerManager&action=info">Page information</option><option value="/index.php?title=SMILA/Documentation/WorkerManager&oldid=325818">Permanent link</option><option value="/index.php?title=SMILA/Documentation/WorkerManager&printable=yes">Printable version</option><option value="/Special:SpecialPages">Special pages</option><option value="/Special:RecentChangesLinked/SMILA/Documentation/WorkerManager">Related changes</option><option value="/Special:WhatLinksHere/SMILA/Documentation/WorkerManager">What links here</option></select><ul class="ul-left-nav fa-ul hidden-print leftnav hidden-xs hidden-sm"><li class="separator"><span class="separator">Toolbox</span></li><li><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/WorkerManager&action=info" id="t-info">Page information</a></li><li><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/WorkerManager&oldid=325818" id="t-permalink" title="Permanent link to this revision of the page">Permanent link</a></li><li><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/WorkerManager&printable=yes" id="t-print" rel="alternate" title="Printable version of this page [p]" accesskey="p">Printable version</a></li><li><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="http://wiki.eclipse.org/Special:SpecialPages" id="t-specialpages" title="A list of all special pages [q]" accesskey="q">Special pages</a></li><li><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="http://wiki.eclipse.org/Special:RecentChangesLinked/SMILA/Documentation/WorkerManager" id="t-recentchangeslinked" title="Recent changes in pages linked from this page [k]" accesskey="k">Related changes</a></li><li><i class="fa fa-angle-double-right orange fa-fw"></i> <a href="http://wiki.eclipse.org/Special:WhatLinksHere/SMILA/Documentation/WorkerManager" id="t-whatlinkshere" title="A list of all wiki pages that link here [j]" accesskey="j">What links here</a></li></ul> </aside> |
| <!-- /leftcol --> |
| |
| <!-- mainContent --> |
| <div id="mainContent" class="col-md-20"> |
| <ul class="nav nav-tabs noprint hidden-print" role="tablist"> |
| <li id="ca-nstab-main" class="active"><a href="WorkerManager.html" title="View the content page [c]" accesskey="c" tabindex="-1">Page</a></li> |
| <li id="ca-talk" class="new"><a href="http://wiki.eclipse.org/index.php?title=Talk:SMILA/Documentation/WorkerManager&action=edit&redlink=1" title="Discussion about the content page [t]" accesskey="t" tabindex="-1">Discussion</a></li> |
| <li id="ca-viewsource"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/WorkerManager&action=edit" title="This page is protected. You can view its source [e]" accesskey="e" tabindex="-1">View source</a></li> |
| <li id="ca-history" class="collapsible"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/WorkerManager&action=history" title="Past revisions of this page [h]" accesskey="h" tabindex="-1">History</a></li> |
| </ul> <div class="tab-content background-white"> |
| <div id="tab-pane-main-page-content" class="tab-pane active"> |
| |
| |
| <h1 id="firstHeading" class="firstHeading page-header"> |
| <span dir="auto">SMILA/Documentation/WorkerManager</span> |
| </h1> |
| <div id="main-page-content"> |
| <!-- subtitle --> |
| <div id="contentSub" class="alert alert-small alert-warning"><span class="subpages">< <a href="../../SMILA.html" title="SMILA">SMILA</a>‎ | <a href="../Documentation.1.html" title="SMILA/Documentation">Documentation</a></span></div> |
| <!-- /subtitle --> |
| |
| |
| <div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><div id="toc" class="toc"><div id="toctitle"><h2>Contents</h2></div> |
| <ul> |
| <li class="toclevel-1 tocsection-1"><a href="WorkerManager.html#WorkerManager"><span class="tocnumber">1</span> <span class="toctext">WorkerManager</span></a> |
| <ul> |
| <li class="toclevel-2 tocsection-2"><a href="WorkerManager.html#Introduction"><span class="tocnumber">1.1</span> <span class="toctext">Introduction</span></a></li> |
| <li class="toclevel-2 tocsection-3"><a href="WorkerManager.html#Overview"><span class="tocnumber">1.2</span> <span class="toctext">Overview</span></a></li> |
| <li class="toclevel-2 tocsection-4"><a href="WorkerManager.html#ScaleUp"><span class="tocnumber">1.3</span> <span class="toctext">ScaleUp</span></a></li> |
| <li class="toclevel-2 tocsection-5"><a href="WorkerManager.html#Task_result_handling"><span class="tocnumber">1.4</span> <span class="toctext">Task result handling</span></a></li> |
| <li class="toclevel-2 tocsection-6"><a href="WorkerManager.html#Input.2FOutput_Data_Objects"><span class="tocnumber">1.5</span> <span class="toctext">Input/Output Data Objects</span></a></li> |
| <li class="toclevel-2 tocsection-7"><a href="WorkerManager.html#Canceling_Tasks"><span class="tocnumber">1.6</span> <span class="toctext">Canceling Tasks</span></a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| |
| <h1><span class="mw-headline" id="WorkerManager">WorkerManager</span></h1> |
| <h2><span class="mw-headline" id="Introduction">Introduction</span></h2> |
| <p>The WorkerManager service of SMILA provides an environment to make it easy to integrate, deploy and scale <a href="../Glossary.html#W" title="SMILA/Glossary">Workers</a>, i.e. classes that implement a functionality to be coordinated by <a href="../Glossary.html#W" title="SMILA/Glossary">asynchronous workflows</a> of SMILA. The WorkerManager service provides all the managements of <a href="../Glossary.html#T" title="SMILA/Glossary">tasks</a> and <a href="../Glossary.html#D" title="SMILA/Glossary">data objects</a> to be consumed and produced by the worker so that the implementation can focus on the real work to be done. |
| </p> |
| <h2><span class="mw-headline" id="Overview">Overview</span></h2> |
| <p>Workers are implemented as OSGi services that are referenced by the WorkerManager and announces its name via a <tt>getName()</tt> method. The WorkerManager then reads the worker definition from the JobManager to check if the worker is known to the JobManager and to get access worker modes or other definitions. It asks the TaskManager for available tasks to be done by this worker. If it gets one, it creates a TaskContext, that wraps up all data and facility the worker function needs to process the task: |
| </p> |
| <ul> |
| <li> the task itself, including all parameters and properties. |
| </li> |
| <li> access to the data objects in the input and output slots of the worker. The data objects can be accessed in different ways as needed by the worker function: direct stream access, record-by-record reading and writing. The framework cares about creating only data objects that are really needed and committing objects after the function has finished successfully. |
| </li> |
| <li> counters to measure performance or other worker statistics. The WorkerManager already produces some basic counters measuring the execution time of the worker and amounts of data read and written. The worker function may produce additional counters as needed. |
| </li> |
| </ul> |
| <p>As long as the worker is performing a task, the WorkerManager keeps the task alive in the TaskManager and notifies the worker about task cancellation. When the worker finished the task processing, the WorkerManager cares about finishing the task: successfully if no error has occurred, or with as a fatal or recoverable error, based on the type of exception thrown by the worker function. |
| </p><p><a href="http://wiki.eclipse.org/File:Smila-workermanager.png" class="image"><img alt="Smila-workermanager.png" src="http://wiki.eclipse.org/images/c/c6/Smila-workermanager.png" width="725" height="460" /></a> |
| </p> |
| <h2><span class="mw-headline" id="ScaleUp">ScaleUp</span></h2> |
| <p>The WorkerManager controls the number of tasks that are allowed for each managed worker on a node in parallel (scale-up). It does not retrieve further tasks for a worker if its scale-up limit is reached, even if a lot more tasks are waiting. Note that even if the worker scale-up limit is not yet reached the TaskManager may refuse to deliver further tasks for a worker if the global node scale-up limit specificed as taskmanager.maxScaleUp is reached already. Workers may declare themselves as runAlways. This means that the global scale-up limit is not applied to this worker. |
| </p> |
| <h2><span class="mw-headline" id="Task_result_handling">Task result handling</span></h2> |
| <p>There are four possible outcomes of a worker's processing: |
| </p> |
| <ul> |
| <li> The perform() method returns normally. This is interpreted by the WorkerManager as a successful task execution and it will finish the task with a SUCCESSFUL task completion status. All open output data objects will be committed (if this fails: continue below depending on the exception type). The task result includes all counters produced by the task execution in the task result so that they can be aggregated by the JobManager in the job run data. |
| </li> |
| <li> The perform() method aborts with a RecoverableTaskException, a IOException, UnavailableException or a MaybeRecoverableException (or subclass) with isRecoverable() == true. This will be interpreted as a temporary failure to access input data or write output data to objectstore, so the task will be finished with a RECOVERABLE_ERROR task completion status and the JobManager will usually reschedule the task for a retry. Produced counters will be ignored. |
| </li> |
| <li> The perform() method aborts with a PostponeTaskException. This means that the worker cannot yet perform this task for some reason but it should be processed later. The task will be readded to the todo queue for this worker and redelivered later (but very soon, usually). |
| </li> |
| <li> The perform() method aborts with any other exception (including all RuntimeExceptions). This will be interpreted as a sign that the input data cannot be processed at all (because it is corrupted or contains invalid values, for example). Such tasks will be finished with a FATAL_ERROR completion status and not rescheduled. Produced counters will be ignored. |
| </li> |
| </ul> |
| <p>There is currently no other way for the workers to influence the task result. |
| </p> |
| <h2><span class="mw-headline" id="Input.2FOutput_Data_Objects">Input/Output Data Objects</span></h2> |
| <p>A task assigns "data objects" to the input and output slots of a worker that represents objects in a objectstore. The WorkerManager framework provides so called IODataObjects that encapsulate the access to these objectstore objects, so the worker does not need to know in detail how to work with the objectstore API. Apart from encapsulating the objectstore API and taking care of proper committing and cleanup after task processing, these IODataObjects also provide higher-level access methods that makes it easier to handle record bulk or key-value objects, for example. |
| </p><p>Their wrappers can be accessed via the <tt>getInputs()</tt> and <tt>getOutput()</tt> components of the task context. Of course, these inputs and outputs managers give also access to the plain bulk info objects using getDataObject methods. However, in this case the worker function must clean up and commit by itself after finishing processing, so this should probably be used if you need only the object ID of an object, but not the actual content. |
| </p><p>Available input wrappers are: |
| </p> |
| <ul> |
| <li> StreamInput: provides direct access to the java.io.InputStream for reading from objectstore. Play with each single byte as you like. |
| </li> |
| <li> RecordInput: provides access to objects like record bulks that are sequences of BON records. You can get single records (or Anys) from the objects, one at a time, by calling the getRecord() method. When end-of-stream is reached, null is returned. You can also access the IpcStreamReader BON parser in case you do not want to read complete records at once. However, you should not mix up getRecord() calls with calls to the IpcStreamReader as your direct calls will probably confuse the record parsing. |
| </li> |
| </ul> |
| <p>Available output wrappers are: |
| </p> |
| <ul> |
| <li> StreamOutput: provides direct access to the java.io.OutputStream for writing to objectstore. |
| </li> |
| <li> RecordOutput: simplified access for creating record bulks by writing one Record (or Any) at a time. You can also directory access the underlying IpcStreamWriter BON writer, but again you should not mix up direct acess the BON writer with the writeRecord/Any() methods. |
| </li> |
| </ul> |
| <p>You can create only a single IO wrapper for each data object. On the second call, only null will be returned. |
| </p><p>For the Stream and Record wrappers the Inputs/Outputs classes provide special getAs... methods. For other wrappers you can use the generic getAs...(String slotName, Class wrapperClass) methods. |
| Additionally, this allows you to create your own input/output wrapper classes and get them managed by the Inputs/Outputs framework. |
| </p> |
| <h2><span class="mw-headline" id="Canceling_Tasks">Canceling Tasks</span></h2> |
| <p>If the WorkerManager receives an 404 NOT FOUND response when trying to keep-alive a currently processed task, it sets a canceled flag in the associated TaskContext object. The worker should regularly check this flag to see if it should still continue to process the task or if it can abort. If so, it can just return (after releasing and cleaning-up used resources that are not part of the task context, of course), the WorkerManager will not commit the results in this case and will not try to finish the task. |
| </p> |
| <!-- |
| NewPP limit report |
| CPU time usage: 0.084 seconds |
| Real time usage: 0.102 seconds |
| Preprocessor visited node count: 26/1000000 |
| Preprocessor generated node count: 32/1000000 |
| Post‐expand include size: 0/2097152 bytes |
| Template argument size: 0/2097152 bytes |
| Highest expansion depth: 2/40 |
| Expensive parser function count: 0/100 |
| --> |
| |
| <!-- Saved in parser cache with key my_wiki:pcache:idhash:32488-0!*!0!!en!2!* and timestamp 20150414084547 and revision id 325818 |
| --> |
| </div> |
| <!-- catlinks --> |
| <div id='catlinks' class='catlinks catlinks-allhidden'></div> <!-- /catlinks --> |
| </div> |
| </div> |
| </div> |
| </div> |
| <!-- /maincontent --> |
| |
| <!-- printfooter --> |
| <div class="printfooter"> |
| Retrieved from "<a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/WorkerManager&oldid=325818">http://wiki.eclipse.org/index.php?title=SMILA/Documentation/WorkerManager&oldid=325818</a>" </div> |
| <!-- /printfooter --> |
| |
| |
| <!-- debughtml --> |
| <!-- /debughtml --> |
| |
| </div> |
| <!-- /bodyContent --> |
| </section> |
| <!-- /content --> |
| |
| <!-- footer --> |
| |
| </div> <section id="footer-contribution-info" style="border-top:1px solid #ccc;" class="footer-offset background-white margin-top-25"><div class="container text-center padding-top-10 padding-bottom-10"><p id="footercredit">This page was last modified 10:42, 8 January 2013 by <a href="http://wiki.eclipse.org/index.php?title=User:Dhaenssgen.brox.de&action=edit&redlink=1" class="new" title="User:Dhaenssgen.brox.de (page does not exist)">Daniel Hänßgen</a>. Based on work by <a href="http://wiki.eclipse.org/index.php?title=User:Juergen.schumacher.attensity.com&action=edit&redlink=1" class="new" title="User:Juergen.schumacher.attensity.com (page does not exist)">Juergen Schumacher</a>, <a href="http://wiki.eclipse.org/User:Andreas.Weber.empolis.com" title="User:Andreas.Weber.empolis.com">Andreas Weber</a> and <a href="http://wiki.eclipse.org/index.php?title=User:Nadine.auslaender.attensity.com&action=edit&redlink=1" class="new" title="User:Nadine.auslaender.attensity.com (page does not exist)"> </a> and <a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/WorkerManager&action=credits" title="SMILA/Documentation/WorkerManager">others</a>.</p><p id="footerviews">This page has been accessed 1,975 times.</p></div></section> </main> <!-- /#main-content-container-row --> |
| <p id="back-to-top" class="noprint hidden-print"> |
| <a class="visible-xs" href="WorkerManager.html#top">Back to the top</a> |
| </p> |
| <footer role="contentinfo" class="noprint hidden-print"> |
| <div class="container"> |
| <div class="row"> |
| <section id="footer-eclipse-foundation" class="col-xs-offset-1 col-xs-11 col-sm-7 col-md-6 col-md-offset-0"> |
| <h2 class="section-title">Eclipse Foundation</h2> |
| <ul class="nav"> |
| <li><a href="https://eclipse.org/org/">About us</a></li> |
| <li><a href="https://eclipse.org/org/foundation/contact.php">Contact Us</a></li> |
| <li><a href="https://eclipse.org/donate">Donate</a></li> |
| <li><a href="https://eclipse.org/org/documents/">Governance</a></li> |
| <li><a href="https://eclipse.org/artwork/">Logo and Artwork</a></li> |
| <li><a href="https://eclipse.org/org/foundation/directors.php">Board of Directors</a></li> |
| </ul> |
| </section> |
| <section id="footer-legal" class="col-xs-offset-1 col-xs-11 col-sm-7 col-md-6 col-md-offset-0"> |
| <h2 class="section-title">Legal</h2> |
| <ul class="nav"> |
| <li><a href="https://eclipse.org/legal/privacy.php">Privacy Policy</a></li> |
| <li><a href="https://eclipse.org/legal/termsofuse.php">Terms of Use</a></li> |
| <li><a href="https://eclipse.org/legal/copyright.php">Copyright Agent</a></li> |
| <li><a href="https://eclipse.org/org/documents/epl-v10.php">Eclipse Public License </a></li> |
| <li><a href="https://eclipse.org/legal/">Legal Resources </a></li> |
| |
| </ul> |
| </section> |
| |
| <section id="footer-useful-links" class="col-xs-offset-1 col-xs-11 col-sm-7 col-md-6 col-md-offset-0"> |
| <h2 class="section-title">Useful Links</h2> |
| <ul class="nav"> |
| <li><a href="https://bugs.eclipse.org/bugs/">Report a Bug</a></li> |
| <li><a href="http://help.eclipse.org/">Documentation</a></li> |
| <li><a href="https://eclipse.org/contribute/">How to Contribute</a></li> |
| <li><a href="https://eclipse.org/mail/">Mailing Lists</a></li> |
| <li><a href="https://eclipse.org/forums/">Forums</a></li> |
| <li><a href="http://marketplace.eclipse.org/">Marketplace</a></li> |
| </ul> |
| </section> |
| |
| <section id="footer-other" class="col-xs-offset-1 col-xs-11 col-sm-7 col-md-6 col-md-offset-0"> |
| |
| <h2 class="section-title">Other</h2> |
| <ul class="nav"> |
| <li><a href="https://eclipse.org/ide/">IDE and Tools</a></li> |
| <li><a href="https://eclipse.org/projects">Community of Projects</a></li> |
| <li><a href="https://eclipse.org/org/workinggroups/">Working Groups</a></li> |
| </ul> |
| |
| <ul class="list-inline social-media"> |
| <li><a href="https://twitter.com/EclipseFdn"><i class="fa fa-twitter-square"></i></a></li> |
| <li><a href="https://plus.google.com/+Eclipse"><i class="fa fa-google-plus-square"></i></a></li> |
| <li><a href="https://www.facebook.com/eclipse.org"><i class="fa fa-facebook-square"></i> </a></li> |
| <li><a href="https://www.youtube.com/user/EclipseFdn"><i class="fa fa-youtube-square"></i></a></li> |
| </ul> |
| |
| </section> |
| <div id="copyright" class="col-xs-offset-1 col-sm-14 col-md-24 col-md-offset-0"> |
| <div> |
| <span><img src="http://eclipse.org/eclipse.org-common/themes/solstice/public/images/logo/eclipse-logo-bw-800x188.png" alt="Eclipse.org black and white logo" width="166" height="39" id="logo-eclipse-white"/></span> |
| <p id="copyright-text">Copyright © 2014 The Eclipse Foundation. All Rights Reserved.</p> |
| </div> |
| </div> |
| <a href="WorkerManager.html#" class="scrollup">Back to the top</a> |
| </div> |
| </div> |
| </footer> |
| |
| <script src="http://wiki.eclipse.org/skins/solstice/public/javascript/main.min.js"></script> |
| |
| <!-- Placed at the end of the document so the pages load faster --> |
| <script type="text/javascript"> |
| |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-910670-2']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| |
| </script> <!-- /footer --> |
| <script>/*<![CDATA[*/window.jQuery && jQuery.ready();/*]]>*/</script><script>if(window.mw){ |
| mw.loader.state({"skins.solstice":"loading","site":"ready","user":"ready","user.groups":"ready"}); |
| }</script> |
| <script src="http://wiki.eclipse.org/load.php?debug=false&lang=en&modules=skins.solstice&only=scripts&skin=solstice&*"></script> |
| <script>if(window.mw){ |
| mw.loader.load(["mediawiki.action.view.postEdit","mediawiki.user","mediawiki.hidpi","mediawiki.page.ready","mediawiki.searchSuggest"],null,true); |
| }</script> |
| <script>if(window.mw){ |
| mw.config.set({"wgBackendResponseTime":369}); |
| }</script> </body> |
| </html> |
