include/alp/uda.h File Reference

Detailed Description

Public API for the Unified Data Access library, used by PDI Library.

#include <stdarg.h>
#include <alp/config.h>
#include <alp/types.h>

Go to the source code of this file.

Data Structures

struct _AlpUDAFilter

An UDA filter. More...

struct _AlpUDAObject

An UDA object. More...

struct _AlpUDAReader

An UDA reader. More...

struct _AlpUDAWriter

An UDA writer. More...

Defines

#define alp_uda_delete(ioObject)

Delete an object.

#define ALP_UDA_END_OF_READER   ((uint16_t) 1)

The "end of reader" option flag.

#define ALP_UDA_MORE_DATA   ((uint16_t) 2)

The "more data" option flag.

#define ALP_UDA_REINITIALIZE   ((uint16_t) 1)

Control code to re-initialize an object.

#define ALP_UDA_STATUS_CONTROL   ((alp_status_t) ALP_CLASS_PDIUDA | 1)

Control function failed.

#define ALP_UDA_ZERO_TERMINATED_BUFFER   0xFFFF

Special value for buffer sier indicating a zero terminated buffer (string).

Typedefs

typedef uint32_t AlpUDABufferSize

The UDA standard buffer size type.

typedef alp_status_t(* AlpUDAControlFunction )(struct _AlpUDAObject *ioObject, uint16_t parameter, va_list args)

The control callback prototype.

typedef void(* AlpUDADeleteFunction )(struct _AlpUDAObject **ioObject)

The delete callback prototype.

typedef _AlpUDAFilter AlpUDAFilter

An UDA filter.

typedef alp_status_t(* AlpUDAFlushFunction )(struct _AlpUDAWriter *ioWriter)

The flush callback prototype.

typedef _AlpUDAObject AlpUDAObject

An UDA object.

typedef _AlpUDAReader AlpUDAReader

An UDA reader.

typedef AlpUDABufferSize(* AlpUDAReadFunction )(struct _AlpUDAReader *ioReader, uint8_t *buffer, AlpUDABufferSize bufferSize, alp_status_t *error)

The read callback prototype.

typedef alp_status_t(* AlpUDAWriteFunction )(struct _AlpUDAWriter *ioWriter)

The write callback prototype.

typedef _AlpUDAWriter AlpUDAWriter

An UDA writer.

Generated on Wed Jul 30 07:06:40 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation


Data Structures
struct	_AlpUDAFilter
	An UDA filter. More...
struct	_AlpUDAObject
	An UDA object. More...
struct	_AlpUDAReader
	An UDA reader. More...
struct	_AlpUDAWriter
	An UDA writer. More...
Defines
#define	alp_uda_delete(ioObject)
	Delete an object.
#define	ALP_UDA_END_OF_READER ((uint16_t) 1)
	The "end of reader" option flag.
#define	ALP_UDA_MORE_DATA ((uint16_t) 2)
	The "more data" option flag.
#define	ALP_UDA_REINITIALIZE ((uint16_t) 1)
	Control code to re-initialize an object.
#define	ALP_UDA_STATUS_CONTROL ((alp_status_t) ALP_CLASS_PDIUDA \| 1)
	Control function failed.
#define	ALP_UDA_ZERO_TERMINATED_BUFFER 0xFFFF
	Special value for buffer sier indicating a zero terminated buffer (string).
Typedefs
typedef uint32_t	AlpUDABufferSize
	The UDA standard buffer size type.
typedef alp_status_t(*	AlpUDAControlFunction )(struct _AlpUDAObject *ioObject, uint16_t parameter, va_list args)
	The control callback prototype.
typedef void(*	AlpUDADeleteFunction )(struct _AlpUDAObject **ioObject)
	The delete callback prototype.
typedef _AlpUDAFilter	AlpUDAFilter
	An UDA filter.
typedef alp_status_t(*	AlpUDAFlushFunction )(struct _AlpUDAWriter *ioWriter)
	The flush callback prototype.
typedef _AlpUDAObject	AlpUDAObject
	An UDA object.
typedef _AlpUDAReader	AlpUDAReader
	An UDA reader.
typedef AlpUDABufferSize(*	AlpUDAReadFunction )(struct _AlpUDAReader ioReader, uint8_t buffer, AlpUDABufferSize bufferSize, alp_status_t *error)
	The read callback prototype.
typedef alp_status_t(*	AlpUDAWriteFunction )(struct _AlpUDAWriter *ioWriter)
	The write callback prototype.
typedef _AlpUDAWriter	AlpUDAWriter
	An UDA writer.