API for client connections

Classes
struct	as_filter_fortran_t
struct	as_filter_t
struct	as_filter_param_t
Defines
#define	AS_MAX_PROC_LEN   16
#define	AS_CAP_PACKET_TAG   0xFE
#define	AS_MIN_FILTER_INDEX   0
#define	AS_MAX_FILTER_INDEX   9
#define	AS_MAX_FILTER   32
Typedefs
typedef as_alarm_s	as_alarm_t
typedef int(*)	AS_HOOK_FCT (void)
Enumerations
enum	as_completion_e {   AS_RC_OK = 0, AS_RC_ALARMBUFFER_EMPTY, AS_RC_NOT_CONNECTED, AS_RC_ALREADY_CONNECTED,   AS_RC_INVALID_REQUEST, AS_RC_REQUEST_FAILED, AS_RC_INVALID_FORMAT, AS_RC_NO_SEND_HANDLER,   AS_RC_SEND_FAILED, AS_RC_NO_ALARM, AS_RC_CONVERT_O2N_ERROR, AS_RC_I_ERROR_000 = 100,   AS_RC_I_ERROR_001, AS_RC_I_ERROR_002, AS_RC_I_ERROR_003, AS_RC_I_ERROR_004,   AS_RC_I_ERROR_005, AS_RC_I_ERROR_006, AS_RC_I_ERROR_007, AS_RC_I_ERROR_008,   AS_RC_I_ERROR_009, AS_RC_I_ERROR_010, AS_RC_I_ERROR_011, AS_RC_I_ERROR_012,   AS_RC_I_ERROR_013, AS_RC_I_ERROR_014, AS_RC_I_ERROR_015, AS_RC_I_ERROR_016,   AS_RC_I_ERROR_017, AS_RC_I_ERROR_018, AS_RC_I_ERROR_019, AS_RC_MAX = 0xFFFFFFFF }
Functions
int	as_connect (char *ourname)
int	as_set_filter (as_filter_t *pfilter, int nfilter)
int	as_disconnect (void)
int	as_set_hook (AS_HOOK_FCT alarm_hook)
int	as_read_alarm (as_alarm_t *palarm)
int	as_read_vms_alarm (as_alarm_t *palarm)
int	as_send_alarm (as_alarm_t *palarm)
int	as_send_vms_alarm (as_alarm_t *palarm)
Variables
as_filter_param_t	AS_ALL

---

Typedef Documentation

typedef struct as_alarm_s as_alarm_t

This is a dummy AlarmType structure. This might be ugly, but we use both the oldalarm type in capacces.h and the new in alarm.hh

typedef int( *) AS_HOOK_FCT(void)

definition of the alarm hook, see as_set_hook()

---

Enumeration Type Documentation

enum as_completion_e

completion codes

---

Function Documentation

int as_connect

(

char *

ourname

)

connect to alarm server

Parameters:

ourname

name of client to connect to alarm server, default: NULL

Returns:

completion code

int as_disconnect

(

void

)

disconnect from alarm server

Returns:

completion code

int as_read_alarm

(

as_alarm_t *

palarm

)

set up a buffer to store the next received alarm

Parameters:

palarm

pointer to alarm structure

Returns:

completion code

int as_read_vms_alarm

(

as_alarm_t *

palarm

)

set up a buffer to store the next received alarm as vms alarm

Parameters:

palarm

pointer to vms alarm structure

Returns:

completion code

int as_send_alarm

(

as_alarm_t *

palarm

)

sends an alarm to alarm server

Parameters:

palarm

pointer to alarm structure

Returns:

completion code

int as_send_vms_alarm

(

as_alarm_t *

palarm

)

sends an (vms-encoded) alarm to alarm server after converting to common alarm object

Parameters:

palarm

pointer to vms alarm structure

Returns:

completion code

int as_set_filter	(	as_filter_t *	pfilter,
		int	nfilter
	)

set filter

Parameters:

pfilter

array of filter to set in alarm server number of filter in array

Returns:

completion code

int as_set_hook

(

AS_HOOK_FCT

alarm_hook

)

set up a hook function which is called when the alarm buffer which was set up in as_read_alarm has been filled

Returns:

completion code

---