opm.h File Reference

Main header for libopm. More...

#include "opm_common.h"

Data Structures
struct	_OPM_CALLBACK
struct	_OPM_CONFIG
struct	_OPM
struct	_OPM_REMOTE
Defines
#define	USE_VAR(var)   static char sizeof##var = sizeof(sizeof##var) + sizeof(var)
#define	RCSID(x)   static char rcsid[] = x; USE_VAR(rcsid);
Typedefs
typedef struct _OPM_CONFIG	OPM_CONFIG_T
typedef struct _OPM	OPM_T
typedef struct _OPM_REMOTE	OPM_REMOTE_T
typedef struct _OPM_CALLBACK	OPM_CALLBACK_T
typedef int	OPM_ERR_T
typedef void	OPM_CALLBACK_FUNC (OPM_T *, OPM_REMOTE_T *, int, void *)
Functions
OPM_T *	opm_create (void)
void	opm_free (OPM_T *)
OPM_REMOTE_T *	opm_remote_create (const char *)
void	opm_remote_free (OPM_REMOTE_T *)
OPM_ERR_T	opm_config (OPM_T *, int, void *)
OPM_ERR_T	opm_scan (OPM_T *, OPM_REMOTE_T *)
void	opm_end (OPM_T *, OPM_REMOTE_T *)
void	opm_endscan (OPM_T *, OPM_REMOTE_T *)
OPM_ERR_T	opm_addtype (OPM_T *, int, unsigned short int)
OPM_ERR_T	opm_remote_addtype (OPM_REMOTE_T *, int, unsigned short int)
OPM_ERR_T	opm_callback (OPM_T *, int, OPM_CALLBACK_FUNC *, void *)
void	opm_cycle (OPM_T *)
size_t	opm_active (OPM_T *)

---

Detailed Description

Main header for libopm.

Author:

Erik Fears

Version:

Id

opm.h,v 1.26 2003/06/20 04:18:44 andy Exp

---

Define Documentation

#define USE_VAR

(

var

)

static char sizeof##var = sizeof(sizeof##var) + sizeof(var)

#define RCSID

(

x

)

static char rcsid[] = x; USE_VAR(rcsid);

---

Typedef Documentation

typedef struct _OPM_CONFIG OPM_CONFIG_T

typedef struct _OPM OPM_T

typedef struct _OPM_REMOTE OPM_REMOTE_T

typedef struct _OPM_CALLBACK OPM_CALLBACK_T

typedef int OPM_ERR_T

typedef void OPM_CALLBACK_FUNC(OPM_T *, OPM_REMOTE_T *, int, void *)

---

Function Documentation

OPM_T* opm_create

(

void

)

void opm_free

(

OPM_T *

)

OPM_REMOTE_T* opm_remote_create

(

const char *

)

void opm_remote_free

(

OPM_REMOTE_T *

)

OPM_ERR_T opm_config	(	OPM_T *	,
		int	,
		void *
	)

OPM_ERR_T opm_scan	(	OPM_T *	,
		OPM_REMOTE_T *
	)

void opm_end	(	OPM_T *	,
		OPM_REMOTE_T *
	)

void opm_endscan	(	OPM_T *	,
		OPM_REMOTE_T *
	)

OPM_ERR_T opm_addtype	(	OPM_T *	,
		int	,
		unsigned short	int
	)

OPM_ERR_T opm_remote_addtype	(	OPM_REMOTE_T *	,
		int	,
		unsigned short	int
	)

OPM_ERR_T opm_callback	(	OPM_T *	,
		int	,
		OPM_CALLBACK_FUNC *	,
		void *
	)

void opm_cycle

(

OPM_T *

)

size_t opm_active

(

OPM_T *

)

---