XQC_OutputStream_s Struct Reference

The XQC_OutputStream struct is designed to be passed to an XQC implementation in order to return streaming data (i.e. More...

#include <zorba/zorbac.h>


Data Fields

void(* free )(XQC_OutputStream stream)
 Called to free the resources associated with the XQC_OutputStream.
void * user_data
 Can be used for user specific purposes.
void(* write )(XQC_OutputStream stream, const char *buf, unsigned int length)
 The function is called to provide the streaming result of a query in the buffer provided.

Detailed Description

The XQC_OutputStream struct is designed to be passed to an XQC implementation in order to return streaming data (i.e.

the result of a query).

Examples:

cserialization.c.

Definition at line 1970 of file zorbac.h.

Field Documentation

void(* XQC_OutputStream_s::free)(XQC_OutputStream stream)

Called to free the resources associated with the XQC_OutputStream.

Free is called by the implementation if it finished writing to the stream.

Parameters:
stream The XQC_OutputStream that this function pointer is a member of
Examples:
cserialization.c.

void* XQC_OutputStream_s::user_data

Can be used for user specific purposes.

Definition at line 1996 of file zorbac.h.

void(* XQC_OutputStream_s::write)(XQC_OutputStream stream, const char *buf, unsigned int length)

The function is called to provide the streaming result of a query in the buffer provided.

Parameters:
stream The XQC_OutputStream that this function pointer is a member of
buf The buffer that contains the data
length The length of the contents in the buffer
Examples:
cserialization.c.

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