Previous section.

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

Supplier Interface

The supplier interface provides a mechanism for managed objects to convey events to the XEMS. Systems Management: Event Management Service - ems_push_supplier_register
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_push_supplier_register () Push Supplier Register

SYNOPSIS

#include <xems.h>

void ems_push_supplier_register(
    ems_netname_t *         hostname,
    ems_handle_t *          handle,
    ems_error_t *           status);

DESCRIPTION

This routine is used by XEMS event suppliers to register with XEMS. This routine should be called once for each host that this supplier wants to push events to.

PARAMETERS

Input

hostname

is the name of the host machine where the Event Service is running. If the hostname is NULL, then the local host is assumed.

Output

handle

returns an XEMS handle which can be used on subsequent calls to XEMS routines.

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_no_memory
ems_s_already_registered
ems_s_insufficient_permission
ems_s_unsupported_nameservice


Systems Management: Event Management Service - ems_supplier_register_handler
Previous section.


NAME


ems_supplier_register_handler - Supplier Register Handler

SYNOPSIS



#include <xems.h>

void ems_supplier_register_handler(
ems_event_type_t type,
ems_supplier_count_handler_t handler,
ems_handle_t * handle,
ems_error_t * status);

DESCRIPTION


This routine is used by XEMS event suppliers to register per event type handlers with XEMS. This routine should be called once for each event type that this supplier wants to provide hints for.

PARAMETERS



Input


type



is the type of event to associate with the handler.

handler



is the callback method to be invoked with XEMS consumer count information.

handle



an XEMS handle.


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_no_memory
ems_s_already_registered
ems_s_insufficient_permission
ems_s_unsupported_nameservice


Systems Management: Event Management Service - ems_pull_supplier_register
Previous section.


NAME


ems_pull_supplier_register - Pull Supplier Register

SYNOPSIS



#include <xems.h>

void ems_pull_supplier_register(
ems_netname_t * hostname,
ems_ushort_int interval,
ems_handle_t * handle,
ems_error_t * status);

DESCRIPTION


This routine is used by XEMS event suppliers to register with XEMS. This routine should be called once for each host that this supplier wants to be a pull supplier for.

PARAMETERS



Input


hostname



is the name of the host machine where the Event Service is running. If the hostname is NULL, then the local host is assumed.

interval



is the suggested polling interval in seconds. This represents the interval that XEMS should use to get events from the supplier. An interval of 0 is a hint to the XEMS to use
pull
rather than
try-pull
semantics.


Output


handle



returns an XEMS handle which can be used on subsequent calls to XEMS routines.

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_no_memory
ems_s_already_registered
ems_s_unsupported_nameservice


Systems Management: Event Management Service - ems_supplier_unregister
Previous section.


NAME


ems_supplier_unregister - Supplier Unregister

SYNOPSIS



#include <xems.h>

void ems_supplier_unregister(
ems_handle_t * handle,
ems_error_t * status);

DESCRIPTION


This routine is used by XEMS event suppliers to unregister with XEMS. This routine should be called once for each call to
ems_push_supplier_register()
or
ems_pull_supplier_register().

PARAMETERS



Input


handle



a valid supplier handle returned from a call to a supplier register routine. This routine will free up memory used by handle, and set handle to NULL.


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_unknown_supplier
ems_s_invalid_handle


Systems Management: Event Management Service - ems_supplier_send
Previous section.


NAME


ems_supplier_send - Supplier Send

SYNOPSIS



#include <xems.h>

void ems_supplier_send(
ems_handle_t handle,
ems_event_t * event,
ems_error_t * status);

DESCRIPTION


This routine is called by event suppliers to send events to the Event Service.

PARAMETERS



Input


handle



should be the handle returned from a call to the ems_register call.

event



contains the actual event data. For the content of the event messages, see the "Data Structures" section.


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_no_memory
ems_s_insufficient_permission

Contents Next section Index