Data Fields
Zorba_OutputStream_s Struct Reference

The Zorba_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 )(Zorba_OutputStream stream)
 Called to free the resources associated with the Zorba_OutputStream.
void * user_data
 Can be used for user specific purposes.
void(* write )(Zorba_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 Zorba_OutputStream struct is designed to be passed to an XQC implementation in order to return streaming data (i.e.

the result of a query).

Definition at line 207 of file zorbac.h.


Field Documentation

Called to free the resources associated with the Zorba_OutputStream.

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

Parameters:
streamThe Zorba_OutputStream that this function pointer is a member of

Definition at line 228 of file zorbac.h.

Can be used for user specific purposes.

Definition at line 233 of file zorbac.h.

void(* Zorba_OutputStream_s::write)(Zorba_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:
streamThe Zorba_OutputStream that this function pointer is a member of
bufThe buffer that contains the data
lengthThe length of the contents in the buffer

Definition at line 218 of file zorbac.h.


The documentation for this struct was generated from the following file:
blog comments powered by Disqus