From: Eric Bollengier <eric@eb.homelinux.org>
Date: Thu, 6 May 2010 11:37:49 +0000 (+0200)
Subject: Document plugin
X-Git-Tag: Release-5.2.1~108
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=ec3d38157cdd6c94be4b05d59f8334630e2f1ae7;p=bacula%2Fdocs

Document plugin
---

diff --git a/docs/manuals/en/developers/pluginAPI.tex b/docs/manuals/en/developers/pluginAPI.tex
index 8996cecc..4856a5dd 100644
--- a/docs/manuals/en/developers/pluginAPI.tex
+++ b/docs/manuals/en/developers/pluginAPI.tex
@@ -367,18 +367,25 @@ typedef struct s_bEvent {
 
 \begin{verbatim}
 typedef enum {
-  bEventJobStart        = 1,
-  bEventJobEnd          = 2,
-  bEventStartBackupJob  = 3,
-  bEventEndBackupJob    = 4,
-  bEventStartRestoreJob = 5,
-  bEventEndRestoreJob   = 6,
-  bEventStartVerifyJob  = 7,
-  bEventEndVerifyJob    = 8,
-  bEventBackupCommand   = 9,
-  bEventRestoreCommand  = 10,
-  bEventLevel           = 11,
-  bEventSince           = 12,
+  bEventJobStart                        = 1,
+  bEventJobEnd                          = 2,
+  bEventStartBackupJob                  = 3,
+  bEventEndBackupJob                    = 4,
+  bEventStartRestoreJob                 = 5,
+  bEventEndRestoreJob                   = 6,
+  bEventStartVerifyJob                  = 7,
+  bEventEndVerifyJob                    = 8,
+  bEventBackupCommand                   = 9,
+  bEventRestoreCommand                  = 10,
+  bEventLevel                           = 11,
+  bEventSince                           = 12,
+  bEventCancelCommand                   = 13,
+  bEventVssBackupAddComponents          = 14,
+  bEventVssRestoreLoadComponentMetadata = 15,
+  bEventVssRestoreSetComponentsSelected = 16,
+  bEventRestoreObject                   = 17,
+  bEventEndFileSet                      = 18,
+  bEventPluginCommand                   = 19
 } bEventType;
 
 \end{verbatim}
@@ -436,6 +443,16 @@ Most of the above are self-explanatory.
 
  \item [bEventSince] is called when the since time is set for a new Job. The 
    value is a time\_t time at which the last job was run.
+
+\item [bEventCancelCommand] is called whenever the currently
+  running Job is cancelled
+
+\item [bEventVssBackupAddComponents] 
+
+\item [bEventPluginCommand] is called for each PluginCommand present in the
+  current FileSet. The event will be sent only on plugin specifed in the
+  command. The argument is the PluginCommand (not valid after the call). 
+
 \end{description}
 
 During each of the above calls, the plugin receives either no specific value or