Main Page   Alphabetical List   Data Structures   File List   Data Fields   Globals  

listeners.h File Reference

Progression notification listeners. More...

Go to the source code of this file.

Enumerations

enum  PmEventType {
  PM_EVENT_PREPARE, PM_EVENT_DEPGRAPH, PM_EVENT_DEPCHECK, PM_EVENT_INSTALL,
  PM_EVENT_UNINSTALL, PM_EVENT_CREATE_DB, PM_EVENT_IMPORT_DB, PM_EVENT_REBUILD_DB
}
 A type of event. More...


Functions

void pmRegisterEventListener (PmEventType type, void(*callback)(PmEventType event_type, int amount, int total, void *data))
 Registers an event listener callback function for the specified event type.

void pmUnregisterEventListener (PmEventType type, void(*callback)(PmEventType event_type, int amount, int total, void *data))
 Unregisters the specified event listener.

void pmBroadcastEvent (PmEventType type, int amount, int total, void *data)
 Broadcasts an event of the specified type to all listeners.


Detailed Description

Progression notification listeners.

Id:
listeners.h,v 1.10 2002/03/18 09:51:14 chipx86 Exp
Copyright:
(C) 1999-2002 The GNUpdate Project.
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.

You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


Enumeration Type Documentation

enum PmEventType
 

A type of event.

Enumeration values:
PM_EVENT_PREPARE  Preparation for an operation.
PM_EVENT_DEPGRAPH  Dependency graph is being generated.
PM_EVENT_DEPCHECK  Dependencies are being checked.
PM_EVENT_INSTALL  Package install event.
PM_EVENT_UNINSTALL  Package uninstall event.
PM_EVENT_CREATE_DB  Database creation event.
PM_EVENT_IMPORT_DB  Database import event.
PM_EVENT_REBUILD_DB  Database rebuild event.


Function Documentation

void pmBroadcastEvent PmEventType    type,
int    amount,
int    total,
void *    data
 

Broadcasts an event of the specified type to all listeners.

Parameters:
type  The type of event to broadcast.
amount  The current amount of the way through (max of total).
total  The total number of steps.
data  Data associated with the event.
See also:
pmRegisterEventListener() , pmUnregisterEventListener()

void pmRegisterEventListener PmEventType    type,
void(*    callback)(PmEventType event_type, int amount, int total, void *data)
 

Registers an event listener callback function for the specified event type.

Parameters:
type  The type of event to register the callback for.
callback  The callback function to call.
See also:
pmBroadcastEvent() , pmUnregisterEventListener()

void pmUnregisterEventListener PmEventType    type,
void(*    callback)(PmEventType event_type, int amount, int total, void *data)
 

Unregisters the specified event listener.

Parameters:
type  The type of event.
callback  The callback function to unregister.
See also:
pmBroadcastEvent() , pmRegisterEventListener()


Generated on Tue Jul 2 03:15:24 2002 for libpackman by doxygen1.2.15-20020430