External HVD interface page complete: passed to RIP with SWEVT_RR_PAGE_COMPLETE events. More...

#include "rrevents.h"

Data Fields
void *	connection

sw_tl_ref	timeline

uint32	page_index

HqnResult	status

Detailed Description

External HVD interface page complete: passed to RIP with SWEVT_RR_PAGE_COMPLETE events.

This message must be a superclass of SWMSG_RR_PAGE_REF. It adds a status field that can be used to indicate errors in page output.

Field Documentation

◆ connection

void* SWMSG_RR_PAGE_COMPLETE::connection

Opaque handle to the connection to which this event is relevant. All handlers whose connection handle doesn't match should immediately return SW_EVENT_CONTINUE.

◆ page_index

uint32 SWMSG_RR_PAGE_COMPLETE::page_index

Index into the pages or tiles defined by SWMSG_RR_PAGE_DEFINE messages. Multiple SWEVT_RR_PAGE_DEFINE events may be received, for different page ranges or tiles of a job. This index is cumulative over all of the page definitions. The page index used in a page ready or page complete message is the zero-based offset into the SWMSG_RR_PAGE_DEFINE::pages array plus the SWMSG_RR_PAGE_DEFINE::page_index_offset offset. This calculation provides a unique index across all of the SWEVT_RR_PAGE_DEFINE events for the connection.

◆ status

HqnResult SWMSG_RR_PAGE_COMPLETE::status

Status of page output operation. This will be HQN_RESULT_SUCCESS if output succeeded, an error code greater than MON_CLASS_ERROR otherwise. The subclass, PS error type, and UID for the error can be deconstructed using the macros in monevent.h.

◆ timeline

sw_tl_ref SWMSG_RR_PAGE_COMPLETE::timeline

Identifies the job containing the pages.

The documentation for this struct was generated from the following file: