gns3-server/gns3server/modules/nios/nio.py

# -*- coding: utf-8 -*-
#
# Copyright (C) 2013 GNS3 Technologies Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""
Base interface for NIOs.
"""


class NIO(object):

    """
    Network Input/Output.
    """

    def __init__(self):

        self._capturing = False
        self._pcap_output_file = ""

    def startPacketCapture(self, pcap_output_file):
        """

        :param pcap_output_file: PCAP destination file for the capture
        """

        self._capturing = True
        self._pcap_output_file = pcap_output_file

    def stopPacketCapture(self):

        self._capturing = False
        self._pcap_output_file = ""

    @property
    def capturing(self):
        """
        Returns either a capture is configured on this NIO.

        :returns: boolean
        """

        return self._capturing

    @property
    def pcap_output_file(self):
        """
        Returns the path to the PCAP output file.

        :returns: path to the PCAP output file
        """

        return self._pcap_output_file