OPacketCapturer API addition: setAutoDelete() and autoDelete()

2 files changed, 31 insertions, 6 deletions

diff --git a/libopie2/opienet/opcap.cpp b/libopie2/opienet/opcap.cpp
index 4081d4f..c5df041 100644
--- a/libopie2/opienet/opcap.cpp
+++ b/libopie2/opienet/opcap.cpp
@@ -57,7 +57,7 @@ namespace Net  {
 OPacket::OPacket( int datalink, packetheaderstruct header, const unsigned char* data, QObject* parent )
         :QObject( parent, "Generic" ), _hdr( header ), _data( data )
 {
-    //qDebug( "OPacket::OPacket(): (Len %d, CapLen %d)" /*, ctime((const time_t*) header.ts.tv_sec)*/, header.len, header.caplen );
+    qDebug( "OPacket::OPacket(): (Len %d, CapLen %d)" /*, ctime((const time_t*) header.ts.tv_sec)*/, header.len, header.caplen );
 
     _end = (unsigned char*) data + header.len;
     //qDebug( "OPacket::data @ %0x, end @ %0x", data, _end );
@@ -87,6 +87,7 @@ OPacket::OPacket( int datalink, packetheaderstruct header, const unsigned char*
 
 OPacket::~OPacket()
 {
+    qDebug( "OPacket::~OPacket( %s )", name() );
 }
 
 
@@ -1063,7 +1064,7 @@ QString OWaveLanControlPacket::controlType() const
  *======================================================================================*/
 
 OPacketCapturer::OPacketCapturer( QObject* parent, const char* name )
-                :QObject( parent, name ), _name( QString::null ), _open( false ), _pch( 0 ), _pcd( 0 ), _sn( 0 )
+                :QObject( parent, name ), _name( QString::null ), _open( false ), _pch( 0 ), _pcd( 0 ), _sn( 0 ), _autodelete( true )
 {
 }
 
@@ -1078,6 +1079,18 @@ OPacketCapturer::~OPacketCapturer()
 }
 
 
+void OPacketCapturer::setAutoDelete( bool b )
+{
+    _autodelete = b;
+}
+
+
+bool OPacketCapturer::autoDelete() const
+{
+    return _autodelete;
+}
+
+
 void OPacketCapturer::setBlocking( bool b )
 {
     if ( pcap_setnonblock( _pch, 1-b, _errbuf ) != -1 )
@@ -1321,8 +1334,8 @@ void OPacketCapturer::readyToReceive()
     odebug << "OPacketCapturer::readyToReceive(): about to emit 'receivePacket(p)'" << oendl;
     OPacket* p = next();
     emit receivedPacket( p );
-    // emit is synchronous - packet has been dealt with, now it's safe to delete
-    delete p;
+    // emit is synchronous - packet has been dealt with, now it's safe to delete (if enabled)
+    if ( _autodelete ) delete p;
 }
 
 
diff --git a/libopie2/opienet/opcap.h b/libopie2/opienet/opcap.h
index 72a78de..4ff8495 100644
--- a/libopie2/opienet/opcap.h
+++ b/libopie2/opienet/opcap.h
@@ -134,9 +134,8 @@ class OPacket : public QObject
 
     void updateStats( QMap<QString,int>&, QObjectList* );
 
-  private:
-
     QString dumpStructure() const;
+  private:
     QString _dumpStructure( QObjectList* ) const;
 
   private:
@@ -693,6 +692,18 @@ class OPacketCapturer : public QObject
      * @see QMap
      */
     const QMap<QString,int>& statistics() const;
+    /**
+     * Enable or disable the auto-delete option.
+     * If auto-delete is enabled, then the packet capturer will delete a packet right
+     * after it has been emit'ted. This is the default, which is useful if the packet
+     * capturer has the only reference to the packets. If you pass the packet for adding
+     * into a collection or do processing after the SLOT, the auto delete must be disabled.
+     */
+    void setAutoDelete( bool enable );
+    /**
+     * @returns the auto-delete value.
+     */
+    bool autoDelete() const;
 
   signals:
     /**
@@ -711,6 +722,7 @@ class OPacketCapturer : public QObject
     QSocketNotifier* _sn;                           // socket notifier for main loop
     mutable char _errbuf[PCAP_ERRBUF_SIZE];         // holds error strings from libpcap
     QMap<QString, int> _stats;                      // statistics;
+    bool _autodelete;                               // if we auto delete packets after emit
             class Private;                             // Private Forward declaration
             Private *d;                                     // if we need to add data
 };