<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2008 (1.71)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Bacula Plugin Entrypoints</TITLE>
<META NAME="description" CONTENT="Bacula Plugin Entrypoints">
<META NAME="keywords" CONTENT="developers">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2008">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="developers.css">
<LINK REL="next" HREF="Building_Bacula_Plugins.html">
<LINK REL="previous" HREF="Plugin_Entry_Points.html">
<LINK REL="up" HREF="Bacula_FD_Plugin_API.html">
<LINK REL="next" HREF="Building_Bacula_Plugins.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html725"
HREF="Building_Bacula_Plugins.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html719"
HREF="Bacula_FD_Plugin_API.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html713"
HREF="Plugin_Entry_Points.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html721"
HREF="Contents.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html723"
HREF="GNU_Free_Documentation_Lice.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html726"
HREF="Building_Bacula_Plugins.html">Building Bacula Plugins</A>
<B> Up:</B> <A NAME="tex2html720"
HREF="Bacula_FD_Plugin_API.html">Bacula FD Plugin API</A>
<B> Previous:</B> <A NAME="tex2html714"
HREF="Plugin_Entry_Points.html">Plugin Entry Points</A>
<B> <A NAME="tex2html722"
HREF="Contents.html">Contents</A></B>
<B> <A NAME="tex2html724"
HREF="GNU_Free_Documentation_Lice.html">Index</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL>
<LI><A NAME="tex2html727"
HREF="Bacula_Plugin_Entrypoints.html#SECTION00451000000000000000">bRC registerBaculaEvents(bpContext *ctx, ...)</A>
<LI><A NAME="tex2html728"
HREF="Bacula_Plugin_Entrypoints.html#SECTION00452000000000000000">bRC getBaculaValue(bpContext *ctx, bVariable var, void *value)</A>
<LI><A NAME="tex2html729"
HREF="Bacula_Plugin_Entrypoints.html#SECTION00453000000000000000">bRC setBaculaValue(bpContext *ctx, bVariable var, void *value)</A>
<LI><A NAME="tex2html730"
HREF="Bacula_Plugin_Entrypoints.html#SECTION00454000000000000000">bRC JobMessage(bpContext *ctx, const char *file, int line,
int type, utime_t mtime, const char *fmt, ...)</A>
<LI><A NAME="tex2html731"
HREF="Bacula_Plugin_Entrypoints.html#SECTION00455000000000000000">bRC DebugMessage(bpContext *ctx, const char *file, int line,
int level, const char *fmt, ...)</A>
<LI><A NAME="tex2html732"
HREF="Bacula_Plugin_Entrypoints.html#SECTION00456000000000000000">void baculaMalloc(bpContext *ctx, const char *file, int line,
size_t size)</A>
<LI><A NAME="tex2html733"
HREF="Bacula_Plugin_Entrypoints.html#SECTION00457000000000000000">void baculaFree(bpContext *ctx, const char *file, int line, void *mem)</A>
</UL>
<!--End of Table of Child-Links-->
<HR>
<H1><A NAME="SECTION00450000000000000000">
Bacula Plugin Entrypoints</A>
</H1>
When Bacula calls one of your plugin entrypoints, you can call back to
the entrypoints in Bacula that were supplied during the xxx plugin call
to get or set information within Bacula.
<P>
<H2><A NAME="SECTION00451000000000000000">
bRC registerBaculaEvents(bpContext *ctx, ...)</A>
</H2>
This Bacula entrypoint will allow you to register to receive events
that are not autmatically passed to your plugin by default. This
entrypoint currently is unimplemented.
<P>
<H2><A NAME="SECTION00452000000000000000">
bRC getBaculaValue(bpContext *ctx, bVariable var, void *value)</A>
</H2>
Calling this entrypoint, you can obtain specific values that are available
in Bacula. The following Variables can be referenced:
<UL>
<LI>bVarJobId returns an int
</LI>
<LI>bVarFDName returns a char *
</LI>
<LI>bVarLevel returns an int
</LI>
<LI>bVarClient returns a char *
</LI>
<LI>bVarJobName returns a char *
</LI>
<LI>bVarJobStatus returns an int
</LI>
<LI>bVarSinceTime returns an int (time_t)
</LI>
<LI>bVarAccurate returns an int
</LI>
</UL>
<P>
<H2><A NAME="SECTION00453000000000000000">
bRC setBaculaValue(bpContext *ctx, bVariable var, void *value)</A>
</H2>
Calling this entrypoint allows you to set particular values in
Bacula. The only variable that can currently be set is
<B>bVarFileSeen</B> and the value passed is a char * that points
to the full filename for a file that you are indicating has been
seen and hence is not deleted.
<P>
<H2><A NAME="SECTION00454000000000000000">
bRC JobMessage(bpContext *ctx, const char *file, int line,
int type, utime_t mtime, const char *fmt, ...)</A>
</H2>
This call permits you to put a message in the Job Report.
<P>
<H2><A NAME="SECTION00455000000000000000">
bRC DebugMessage(bpContext *ctx, const char *file, int line,
int level, const char *fmt, ...)</A>
</H2>
This call permits you to print a debug message.
<P>
<H2><A NAME="SECTION00456000000000000000">
void baculaMalloc(bpContext *ctx, const char *file, int line,
size_t size)</A>
</H2>
This call permits you to obtain memory from Bacula's memory allocator.
<P>
<H2><A NAME="SECTION00457000000000000000">
void baculaFree(bpContext *ctx, const char *file, int line, void *mem)</A>
</H2>
This call permits you to free memory obtained from Bacula's memory allocator.
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html725"
HREF="Building_Bacula_Plugins.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html719"
HREF="Bacula_FD_Plugin_API.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html713"
HREF="Plugin_Entry_Points.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html721"
HREF="Contents.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html723"
HREF="GNU_Free_Documentation_Lice.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html726"
HREF="Building_Bacula_Plugins.html">Building Bacula Plugins</A>
<B> Up:</B> <A NAME="tex2html720"
HREF="Bacula_FD_Plugin_API.html">Bacula FD Plugin API</A>
<B> Previous:</B> <A NAME="tex2html714"
HREF="Plugin_Entry_Points.html">Plugin Entry Points</A>
<B> <A NAME="tex2html722"
HREF="Contents.html">Contents</A></B>
<B> <A NAME="tex2html724"
HREF="GNU_Free_Documentation_Lice.html">Index</A></B>
<!--End of Navigation Panel-->
<ADDRESS>
2012-01-24
</ADDRESS>
</BODY>
</HTML>
