OPacketCapturer API addition: setAutoDelete() and autoDelete()

2 files changed, 33 insertions, 8 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
@@ -48,25 +48,25 @@
 using namespace Opie::Core;
 
 namespace Opie {
 namespace Net  {
 
 /*======================================================================================
  * OPacket
  *======================================================================================*/
 
 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 );
 
     switch ( datalink )
     {
         case DLT_EN10MB:
             odebug << "OPacket::OPacket(): Received Packet. Datalink = ETHERNET" << oendl;
             new OEthernetPacket( _end, (const struct ether_header*) data, this );
             break;
 
         case DLT_IEEE802_11:
@@ -78,24 +78,25 @@ OPacket::OPacket( int datalink, packetheaderstruct header, const unsigned char*
             odebug << "OPacket::OPacket(): Received Packet. Datalink = PRISM_HEADER" << oendl;
             new OPrismHeaderPacket( _end, (const struct prism_hdr*) (unsigned char*) data, this );
             break;
 
         default:
             owarn << "OPacket::OPacket(): Received Packet over unsupported datalink, type " << datalink << "!" << oendl;
     }
 }
 
 
 OPacket::~OPacket()
 {
+    qDebug( "OPacket::~OPacket( %s )", name() );
 }
 
 
 timevalstruct OPacket::timeval() const
 {
     return _hdr.ts;
 }
 
 
 int OPacket::caplen() const
 {
     return _hdr.caplen;
@@ -1054,39 +1055,51 @@ QString OWaveLanControlPacket::controlType() const
         default:
             owarn << "OWaveLanControlPacket::managementType(): unhandled subtype " << FC_SUBTYPE( EXTRACT_LE_16BITS( &_header->fc ) ) << oendl;
             return "Unknown";
     }
 }
 
 
 /*======================================================================================
  * OPacketCapturer
  *======================================================================================*/
 
 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 )
 {
 }
 
 
 OPacketCapturer::~OPacketCapturer()
 {
     if ( _open )
     {
         odebug << "OPacketCapturer::~OPacketCapturer(): pcap still open, autoclosing." << oendl;
         close();
     }
 }
 
 
+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 )
     {
         odebug << "OPacketCapturer::setBlocking(): blocking mode changed successfully." << oendl;
     }
     else
     {
         odebug << "OPacketCapturer::setBlocking(): can't change blocking mode: " << _errbuf << oendl;
     }
 }
 
@@ -1312,26 +1325,26 @@ bool OPacketCapturer::open( const QFile& file )
 
 bool OPacketCapturer::isOpen() const
 {
     return _open;
 }
 
 
 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;
 }
 
 
 const QMap<QString,int>& OPacketCapturer::statistics() const
 {
     return _stats;
 }
 
 
 int OPacketCapturer::snapShot() const
 {
     return pcap_snapshot( _pch );
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
@@ -125,27 +125,26 @@ class OPacket : public QObject
   public:
     OPacket( int datalink, packetheaderstruct, const unsigned char*, QObject* parent );
     virtual ~OPacket();
 
     timevalstruct timeval() const;
 
     int caplen() const;
     int len() const;
     QString dump( int = 32 ) const;
 
     void updateStats( QMap<QString,int>&, QObjectList* );
 
-  private:
-
     QString dumpStructure() const;
+  private:
     QString _dumpStructure( QObjectList* ) const;
 
   private:
     const packetheaderstruct _hdr;  // pcap packet header
     const unsigned char* _data;     // pcap packet data
     const unsigned char* _end;      // end of pcap packet data
   private:
     class Private;
     Private *d;
 };
 
 QTextStream& operator<<( QTextStream& s, const OPacket& p );
@@ -684,38 +683,51 @@ class OPacketCapturer : public QObject
      * than the byte-order of the running system.
      */
     bool swapped() const;
     /**
      * @returns the libpcap version string used to write the input capture file.
      */
     QString version() const;
     /**
      * @returns the packet statistic database.
      * @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:
     /**
      * This signal is emitted, when a packet has been received.
      */
     void receivedPacket( Opie::Net::OPacket* );
 
   protected slots:
     void readyToReceive();
 
   protected:
     QString _name;                                  // devicename
     bool _open;                                     // check this before doing pcap calls
     pcap_t* _pch;                                   // pcap library handle
     pcap_dumper_t* _pcd;                            // pcap dumper handle
     QSocketNotifier* _sn;                           // socket notifier for main loop
     mutable char _errbuf[PCAP_ERRBUF_SIZE];         // holds error strings from libpcap
     QMap<QString, int> _stats;                      // statistics;
-    class Private;			   	    // Private Forward declaration
-    Private *d;					    // if we need to add data
+    bool _autodelete;                               // if we auto delete packets after emit
+    class Private;                                  // Private Forward declaration
+    Private *d;                                     // if we need to add data
 };
 }
 }
 
 #endif // OPCAP_H