Systems Management: Event Management Service

Systems Management; Event Management Service (XEMS)
Copyright © 1997 The Open Group

Event Type Interface

The event type interface provides support for manipulating the event type database. Systems Management: Event Management Service - ems_event_type_add Previous section.

Why not acquire a nicely bound hard copy?
Click here to return to the publication details or order a copy of this publication.

NAME

ems_event_type_add - Add an Event Type.

SYNOPSIS

#include <xems.h>

void ems_event_type_add(
    ems_handle_t            handle,
    ems_event_schema_t *    schema,
    ems_error_t *           status);

DESCRIPTION

This routine is used by an event supplier to add new event types to the EMS event type Database. A supplier can add a new event type, then start producing that event type by transmitting events to EMS.

PARAMETERS

Input

handle

a handle returned from a call to any ems_register call.

schema

is an EMS event type schema which describes the format of an event type.

Output

status

returns the status code from this routine which indicates whether the routine completed successfully or, if not, why not.

RETURN VALUE

The possible status codes are:

ems_s_status_ok
ems_s_invalid_handle
ems_s_event_type_exists
ems_s_insufficient_permission
ems_s_invalid_event_type

Systems Management: Event Management Service - ems_event_type_delete Previous section.

NAME

ems_event_type_delete - Delete an Event Type

SYNOPSIS

#include <xems.h>

void ems_event_type_delete(
    ems_handle_t           handle,
    ems_string_t           type_name,
    ems_event_type_t *     type,
    ems_error_t *          status);

DESCRIPTION

This routine is used by an event supplier to delete an event types in the EMS event type Database.

PARAMETERS

Input

handle

a handle returned from a call to ems_register().

type_name

is the name of an EMS event type.

type

event type id of the EMS event type to delete.

Output

status

returns the status code from this routine which indicates whether the routine completed successfully or, if not, why not.

RETURN VALUE

The possible status codes are:

ems_s_status_ok
ems_s_event_type_not_found
ems_s_invalid_handle
ems_s_invalid_name
ems_s_insufficient_permission

Systems Management: Event Management Service - ems_event_type_get Previous section.

NAME

ems_event_type_get - Get an Event Type

SYNOPSIS

#include <xems.h>

void ems_event_type_get(
    ems_handle_t              handle,
    char *                    type_name,
    ems_event_type_t *        type,
    ems_event_schema_t **     schema, 
    ems_error_t *             status);

DESCRIPTION

This routine is used by an event supplier to get an event types from the EMS event type Database.

PARAMETERS

Input

handle

a handle returned from a call to ems_register().

type_name

is the name of an EMS event type to get.

type

event type id of the EMS event type to get.

Output

schema

event type id of the EMS event type to get.

status

returns the status code from this routine which indicates whether the routine completed successfully or, if not, why not.

RETURN VALUE

The possible status codes are:

ems_s_status_ok
ems_s_event_type_not_found
ems_s_invalid_handle
ems_s_invalid_name
ems_s_insufficient_permission

Systems Management: Event Management Service - ems_event_type_get_list Previous section.

NAME

ems_event_type_get_list - Get Event Types List

SYNOPSIS

#include <xems.h>

void ems_event_type_get_list(
    ems_handle_t                 handle,
    ems_event_type_list_t **     type_list,
    ems_error_t *                status);

DESCRIPTION

This routine is used by EMS event consumers to find out what event types are available to register for. The consumer can then set up filters for attributes in one of the available event types.

PARAMETERS

Input

handle

should be the handle returned from a ems_consumer_register() call.

Output

type_list

returns the list of available event types.

status

returns the status code from this routine which indicates whether the routine completed successfully or, if not, why not.

RETURN VALUE

The possible status codes are:

ems_s_status_ok
ems_s_invalid_handle .
ems_s_no_type_list
ems_s_invalid_name
ems_s_insufficient_permission

Systems Management: Event Management Service - ems_event_type_free_list Previous section.

NAME

ems_event_type_free_list - Free Event Types List

SYNOPSIS

#include <xems.h>

void ems_event_type_free_list(
    ems_event_type_list_t **     type_list,
    ems_error_t *                status);

DESCRIPTION

This routine is used by callers of ems_get_event_types to free the storage used by an event type list.

PARAMETERS

Input

type_list

an event type list as returned by ems_event_type_get_list(). type_list will be set to NULL by this routine.

Output

status

returns the status code from this routine which indicates whether the routine completed successfully or, if not, why not.

RETURN VALUE

The possible status codes are:

ems_s_status_ok

Contents

Next section

Index