The UDA library (Unified Data Access)
[PIM Data Interchange]

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.
Variables
AlpUDAControlFunction	_AlpUDAWriter::controlF
	the control callback
AlpUDAControlFunction	_AlpUDAFilter::controlF
	the control callback
AlpUDAControlFunction	_AlpUDAReader::controlF
	the control callback
AlpUDAControlFunction	_AlpUDAObject::controlF
	the control callback
AlpUDADeleteFunction	_AlpUDAWriter::deleteF
	the destructor callback
AlpUDADeleteFunction	_AlpUDAFilter::deleteF
	the destructor callback
AlpUDADeleteFunction	_AlpUDAReader::deleteF
	the destructor callback
AlpUDADeleteFunction	_AlpUDAObject::deleteF
	the destructor callback
AlpUDAFlushFunction	_AlpUDAWriter::flushF
	the callback to flush data to the writer
AlpUDAWriteFunction	_AlpUDAWriter::initiateWriteF
	the callback to begin a write operation
uint16_t	_AlpUDAWriter::padding
uint16_t	_AlpUDAFilter::padding
uint16_t	_AlpUDAReader::padding
uint16_t	_AlpUDAObject::padding
AlpUDAReadFunction	_AlpUDAFilter::readF
	the read callback
AlpUDAReadFunction	_AlpUDAReader::readF
	the read callback
AlpUDAReader *	_AlpUDAWriter::upperReader
	the reader to read data from
AlpUDAReader *	_AlpUDAFilter::upperReader
	the reader to read data from

---

Define Documentation

#define alp_uda_delete (  ioObject   )

Value: do { \ struct _AlpUDAObject* tempObject = (struct _AlpUDAObject *) ioObject; \ if ( ioObject ) \ { \ ((*(ioObject->deleteF))(&tempObject)); \ ioObject = 0; \ } \ } while (false) 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).

---

Typedef Documentation

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 struct _AlpUDAFilter AlpUDAFilter

An UDA filter.

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

The flush callback prototype.

typedef struct _AlpUDAObject AlpUDAObject

An UDA object.

typedef struct _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 struct _AlpUDAWriter AlpUDAWriter

An UDA writer.

---

Variable Documentation

AlpUDAControlFunction controlF [inherited]

the control callback

AlpUDAControlFunction controlF [inherited]

the control callback

AlpUDAControlFunction controlF [inherited]

the control callback

AlpUDAControlFunction controlF [inherited]

the control callback

AlpUDADeleteFunction deleteF [inherited]

the destructor callback

AlpUDADeleteFunction deleteF [inherited]

the destructor callback

AlpUDADeleteFunction deleteF [inherited]

the destructor callback

AlpUDADeleteFunction deleteF [inherited]

the destructor callback

AlpUDAFlushFunction flushF [inherited]

the callback to flush data to the writer

AlpUDAWriteFunction initiateWriteF [inherited]

the callback to begin a write operation

uint16_t padding [inherited]

uint16_t padding [inherited]

uint16_t padding [inherited]

uint16_t padding [inherited]

AlpUDAReadFunction readF [inherited]

the read callback

AlpUDAReadFunction readF [inherited]

the read callback

AlpUDAReader* upperReader [inherited]

the reader to read data from

AlpUDAReader* upperReader [inherited]

the reader to read data from

---

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

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.