gns3-server/gns3server/modules/nios/nio_generic_ethernet.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/>.

"""
Interface for generic Ethernet NIOs (PCAP library).
"""

from .nio import NIO


class NIOGenericEthernet(NIO):

    """
    Generic Ethernet NIO.

    :param ethernet_device: Ethernet device name (e.g. eth0)
    """

    def __init__(self, ethernet_device):

        super().__init__()
        self._ethernet_device = ethernet_device

    @property
    def ethernet_device(self):
        """
        Returns the Ethernet device used by this NIO.

        :returns: the Ethernet device name
        """

        return self._ethernet_device

    def __str__(self):

        return "NIO Ethernet"

    def __json__(self):

        return {"type": "nio_generic_ethernet",
                "ethernet_device": self._ethernet_device}