Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

sendmail::milter::Milter Class Reference

#include <Milter.hh>

Inheritance diagram for sendmail::milter::Milter:

Inheritance graph
[legend]
List of all members.

Public Methods

 Milter (const char *name, CallbackFactory *factory, const char *connection, int timeout=1800)
virtual ~Milter ()
virtual const CallbackFactorygetCallbackFactory () const
virtual CallbackFactorygetCallbackFactory ()
virtual void start ()
virtual void stop ()
virtual void setDebug (int debug)

Protected Methods

virtual void _registerMilter (const char *name, CallbackFactory *factory, const char *connection, int timeout)

Detailed Description

Milter is the C++ representation of the 'struct smfiDesc' filter description. A process may create only a single instance of a Milter. This is a limitation of the Sendmail Milter API itself, not of this library.


Constructor & Destructor Documentation

sendmail::milter::Milter::Milter const char *    name,
CallbackFactory   factory,
const char *    connection,
int    timeout = 1800
 

Constructs (and registers) a new Milter.

Parameters:
name  the name of this Milter
factory  the factory for Milter Callbacks
connection  a description of the connection to which this Milter should listen. E.g. "inet:1234@127.0.0.1".
timemout  the connection timeout in seconds, default 1800 seconds.

sendmail::milter::Milter::~Milter   [virtual]
 


Member Function Documentation

void sendmail::milter::Milter::_registerMilter const char *    name,
CallbackFactory   factory,
const char *    connection,
int    timeout
[protected, virtual]
 

CallbackFactory & sendmail::milter::Milter::getCallbackFactory   [virtual]
 

returns the CallbackFactory

const CallbackFactory & sendmail::milter::Milter::getCallbackFactory   const [virtual]
 

returns the CallbackFactory

void sendmail::milter::Milter::setDebug int    debug [virtual]
 

Sets the debug level.

Parameters:
debug  the debug level, ranges from 0 to XXX

void sendmail::milter::Milter::start   [virtual]
 

Starts the Milter.

void sendmail::milter::Milter::stop   [virtual]
 

Stops the Milter.


The documentation for this class was generated from the following files:
Generated on Wed Jun 19 21:21:45 2002 for libmilter++ by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002