summaryrefslogtreecommitdiff
path: root/libopie2/opienet/opcap.h
Unidiff
Diffstat (limited to 'libopie2/opienet/opcap.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opienet/opcap.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/libopie2/opienet/opcap.h b/libopie2/opienet/opcap.h
index 2dbe030..9e718d5 100644
--- a/libopie2/opienet/opcap.h
+++ b/libopie2/opienet/opcap.h
@@ -618,99 +618,99 @@ class OPacketCapturer : public QObject
618 */ 618 */
619 ~OPacketCapturer(); 619 ~OPacketCapturer();
620 /** 620 /**
621 * Set the packet capturer to use blocking or non-blocking IO. This can be useful when 621 * Set the packet capturer to use blocking or non-blocking IO. This can be useful when
622 * not using the socket notifier, e.g. without an application object. 622 * not using the socket notifier, e.g. without an application object.
623 */ 623 */
624 void setBlocking( bool ); 624 void setBlocking( bool );
625 /** 625 /**
626 * @returns true if the packet capturer uses blocking IO calls. 626 * @returns true if the packet capturer uses blocking IO calls.
627 */ 627 */
628 bool blocking() const; 628 bool blocking() const;
629 /** 629 /**
630 * Close the packet capturer. This is automatically done in the destructor. 630 * Close the packet capturer. This is automatically done in the destructor.
631 */ 631 */
632 void close(); 632 void close();
633 /** 633 /**
634 * Close the output capture file. 634 * Close the output capture file.
635 */ 635 */
636 void closeDumpFile(); 636 void closeDumpFile();
637 /** 637 /**
638 * @returns the data link type. 638 * @returns the data link type.
639 * @see <pcap.h> for possible values. 639 * @see <pcap.h> for possible values.
640 */ 640 */
641 int dataLink() const; 641 int dataLink() const;
642 /** 642 /**
643 * Dump a packet to the output capture file. 643 * Dump a packet to the output capture file.
644 */ 644 */
645 void dump( OPacket* ); 645 void dump( OPacket* );
646 /** 646 /**
647 * @returns the file descriptor of the packet capturer. This is only useful, if 647 * @returns the file descriptor of the packet capturer. This is only useful, if
648 * not using the socket notifier, e.g. without an application object. 648 * not using the socket notifier, e.g. without an application object.
649 */ 649 */
650 int fileno() const; 650 int fileno() const;
651 /** 651 /**
652 * @returns the next @ref OPacket from the packet capturer. 652 * @returns the next @ref OPacket from the packet capturer.
653 * @note If blocking mode is true then this call might block. 653 * @note If blocking mode is true then this call might block.
654 */ 654 */
655 OPacket* next(); 655 OPacket* next();
656 /** 656 /**
657 * @returns the next @ref OPacket from the packet capturer, if 657 * @returns the next @ref OPacket from the packet capturer, if
658 * one arrives within @a time milliseconds. 658 * one arrives within @a time milliseconds.
659 */ 659 */
660 OPacket* next( int time ); 660 OPacket* next( int time );
661 /** 661 /**
662 * Open the packet capturer to capture packets in live-mode from @a interface. 662 * Open the packet capturer to capture packets in live-mode from @a interface.
663 */ 663 */
664 bool open( const QString& interface ); 664 bool open( const QString& interface );
665 /** 665 /**
666 * Open the packet capturer to capture packets in offline-mode from @a file. 666 * Open the packet capturer to capture packets in offline-mode from @a filename.
667 */ 667 */
668 bool open( const QFile& file ); 668 bool openCaptureFile( const QString& filename );
669 /** 669 /**
670 * Open a prerecorded tcpdump compatible capture file for use with @ref dump() 670 * Open a prerecorded tcpdump compatible capture file for use with @ref dump()
671 */ 671 */
672 bool openDumpFile( const QString& filename ); 672 bool openDumpFile( const QString& filename );
673 /** 673 /**
674 * @returns true if the packet capturer is open 674 * @returns true if the packet capturer is open
675 */ 675 */
676 bool isOpen() const; 676 bool isOpen() const;
677 /** 677 /**
678 * @returns the snapshot length of this packet capturer 678 * @returns the snapshot length of this packet capturer
679 */ 679 */
680 int snapShot() const; 680 int snapShot() const;
681 /** 681 /**
682 * @returns true if the input capture file has a different byte-order 682 * @returns true if the input capture file has a different byte-order
683 * than the byte-order of the running system. 683 * than the byte-order of the running system.
684 */ 684 */
685 bool swapped() const; 685 bool swapped() const;
686 /** 686 /**
687 * @returns the libpcap version string used to write the input capture file. 687 * @returns the libpcap version string used to write the input capture file.
688 */ 688 */
689 QString version() const; 689 QString version() const;
690 /** 690 /**
691 * @returns the packet statistic database. 691 * @returns the packet statistic database.
692 * @see QMap 692 * @see QMap
693 */ 693 */
694 const QMap<QString,int>& statistics() const; 694 const QMap<QString,int>& statistics() const;
695 /** 695 /**
696 * Enable or disable the auto-delete option. 696 * Enable or disable the auto-delete option.
697 * If auto-delete is enabled, then the packet capturer will delete a packet right 697 * If auto-delete is enabled, then the packet capturer will delete a packet right
698 * after it has been emit'ted. This is the default, which is useful if the packet 698 * after it has been emit'ted. This is the default, which is useful if the packet
699 * capturer has the only reference to the packets. If you pass the packet for adding 699 * capturer has the only reference to the packets. If you pass the packet for adding
700 * into a collection or do processing after the SLOT, the auto delete must be disabled. 700 * into a collection or do processing after the SLOT, the auto delete must be disabled.
701 */ 701 */
702 void setAutoDelete( bool enable ); 702 void setAutoDelete( bool enable );
703 /** 703 /**
704 * @returns the auto-delete value. 704 * @returns the auto-delete value.
705 */ 705 */
706 bool autoDelete() const; 706 bool autoDelete() const;
707 707
708 signals: 708 signals:
709 /** 709 /**
710 * This signal is emitted, when a packet has been received. 710 * This signal is emitted, when a packet has been received.
711 */ 711 */
712 void receivedPacket( Opie::Net::OPacket* ); 712 void receivedPacket( Opie::Net::OPacket* );
713 713
714 protected slots: 714 protected slots:
715 void readyToReceive(); 715 void readyToReceive();
716 716