GoWebScanWebTask.h

Go to the documentation of this file.

/**
* @file    GoWebScanWebTask.h
* @brief   Declares a GoWebScanWebTask object.
*
* @internal
* Copyright (C) 2017-2026 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/

#ifndef GO_WEB_SCAN_WEB_TASK_H
#define GO_WEB_SCAN_WEB_TASK_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanPipe.h>
#include <GoWebScanSdk/GoWebScanPipeTask.h>
#include <GoWebScanSdk/GoWebScanConfig.h>

/**
* @class   GoWebScanWebTask
* @extends kObject
* @ingroup GoWebScanSdk-Control
* @brief   Represents a task for combining outputs from multiple Merge Tasks into a single 
*          GoWebScanSystemMsg object.  No additional processing is performed.  In Web Mode, 
*          this is the final stage before results are delivered back to the GoWebScanProcess  
*          object. In Detection mode, the output from GoWebScanWebTask is passed to 
*          GoWebScanDetectionTask for additional processing. The task accepts 
*          GoWebScanProfileTileMsg, GoWebScanVisionTileMsg, and GoWebScanTracheidTileMsg
*          objects and outputs GoWebScanSystemMsg objects.
*          
*          Tiles are assembled using the GoWebScanTileCombiner algorithm. Tiles not are 
*          copied when creating a GoWebScanSystemMsg object. The reference count on the 
*          original tiles is incremented when they are added to a GoWebScanSystemMsg, and 
*          decremented when the GoWebScanSystemMsg is freed. 
*/
typedef kObject GoWebScanWebTask;

// Forward declaration
typedef kObject GoWebScanProcess;

/**
* Constructs a GoWebScanWebTask object.
* 
* @public              @memberof GoWebScanWebTask
* @param   task        Receives the constructed GoWebScanWebTask object.
* @param   process     Associated GoWebScanProcess object which will receive the detected result.
* @param   config      System configuration.
* @param   allocator   Memory allocator (or kNULL for default).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanWebTask_Construct(GoWebScanWebTask* task, GoWebScanProcess process, GoWebScanConfig config, kAlloc allocator);

/**
* Sets the handler for receiving emitted web tiles.
*
* @public           @memberof GoWebScanWebTask
* @param  task      GoWebScanWebTask object. 
* @param  send      Callback function
* @param  context   Receiver argument for callback.
* @return           Operation status.
*/
GoWebScanFx(kStatus) GoWebScanWebTask_SetReceiver(GoWebScanWebTask task, GoWebScanPipeSendFx send, kPointer context);

/**
* Adds a message to the processing queue. Dequeues a message at the end of the queue to submit
* to the pipe for scheduling if no other job is currently pending.
* 
* @public          @memberof GoWebScanWebTask
* @param   task    GoWebScanWebTask object.
* @param   msg     Message to enqueue.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanWebTask_Send(GoWebScanWebTask task, GoWebScanPipeMsg msg);

/**
* Clears the tile combiner algorithm and resets internal variables.
* 
* @public          @memberof GoWebScanWebTask
* @param   task    GoWebScanWebTask object.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanWebTask_Clear(GoWebScanWebTask task);

#include <GoWebScanSdk/GoWebScanWebTask.x.h>

#endif