GoWebScanPipeMsg.h

Go to the documentation of this file.

/**
* @file    GoWebScanPipeMsg.h
* @brief   Declares the GoWebScanPipeMsg class
*
* @internal
* Copyright (C) 2017-2026 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/
#ifndef GO_SCANNER_PIPE_MSG_H
#define GO_SCANNER_PIPE_MSG_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @class   GoWebScanPipeMsg
* @extends kObject
* @ingroup GoWebScanSdk-Pipe
* @brief   Base class for a msg that can be processed with a GoWebScanPipeTask and submitted to the GoWebScanPipe for scheduling.
*          GoWebScanPipeMsg objects have a thread-safe reference count.  GoWebScanPipeMsg objects are always allocated from 
*          GoWebScanPipeMsgPool objects with a default reference count of 1.  When the reference count reaches zero, the message is 
*          recycled to the pool free list.  This allows for efficient reuse of message memory. 
*/
typedef kObject GoWebScanPipeMsg; 

// Forward declarations
typedef kObject GoWebScanPipeMsgPool;

/**
* Increments the msg's reference count.
*
* @public                     @memberof GoWebScanPipeMsg
* @param  msg                 GoWebScanPipeMsg object.
* @return                     Operation status.
*/
GoWebScanFx(kStatus) GoWebScanPipeMsg_Acquire(GoWebScanPipeMsg msg);

/**
* Decrements the msg's reference count. If the count reaches zero, the message is recycled to the
* GoWebScanPipeMsgPool free list.
*
* @public                     @memberof GoWebScanPipeMsg
* @param  msg                 GoWebScanPipeMsg object.
* @return                     Operation status.
*/
GoWebScanFx(kStatus) GoWebScanPipeMsg_Relinquish(GoWebScanPipeMsg msg);

/**
* Sets the stamp associated with the message.
*
* @public                     @memberof GoWebScanPipeMsg
* @param  msg                 GoWebScanPipeMsg object.
* @param  stamp               Message stamp.
* @return                     Operation status.
*/
GoWebScanFx(kStatus) GoWebScanPipeMsg_SetStamp(GoWebScanPipeMsg msg, const GoWebScanMsgStamp* stamp);

/**
* Gets the stamp associated with the message.
*
* @public                     @memberof GoWebScanPipeMsg
* @param  msg                 GoWebScanPipeMsg object.
* @return                     Message stamp.
*/
GoWebScanFx(GoWebScanMsgStamp*) GoWebScanPipeMsg_GetStamp(GoWebScanPipeMsg msg);

/**
* Gets the message type.
*
* @public                     @memberof GoWebScanPipeMsg
* @param  msg                 GoWebScanPipeMsg object.
* @return                     Message type.
*/
GoWebScanFx(GoWebScanMsgType) GoWebScanPipeMsg_TypeId(GoWebScanPipeMsg msg);

/**
* Gets the size, in bytes, of the message's data buffer.
*
* @public                     @memberof GoWebScanPipeMsg
* @param  msg                 GoWebScanPipeMsg object.
* @return                     Message size.
*/
GoWebScanFx(kSize) GoWebScanPipeMsg_Size(GoWebScanPipeMsg msg);

#include <GoWebScanSdk/GoWebScanPipeMsg.x.h>

#endif