mirror of
https://github.com/joncampbell123/dosbox-x.git
synced 2025-05-09 03:41:10 +08:00
92 lines
4.1 KiB
C++
92 lines
4.1 KiB
C++
/*
|
|
* Copyright (C) 2021 The DOSBox Team
|
|
*
|
|
* 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 2 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, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef DOSBOX_ETHERNET_H
|
|
#define DOSBOX_ETHERNET_H
|
|
|
|
#include "control.h"
|
|
|
|
/** A virtual Ethernet connection
|
|
* While emulated Ethernet adapters provide the ability for the guest OS to
|
|
* send and receive Ethernet packets, the emulator itself needs to pass these
|
|
* packets to device on the host system.
|
|
* The EthernetConnection class provides a virtual connection for passing
|
|
* packets to and from a backend, intended for use by emulated adapter code.
|
|
*/
|
|
class EthernetConnection
|
|
{
|
|
public:
|
|
/** Initializes the connection.
|
|
* After creating an EthernetConnection, it must have its connection
|
|
* opened and initialized before further use.
|
|
* This is done in a separate function instead of a constructor so any
|
|
* error code may be propagated.
|
|
* Do not call this function twice.
|
|
* @param config The connection's configuration section
|
|
* @return True if the connection is initialized, false otherwise
|
|
*/
|
|
virtual bool Initialize(Section* config) = 0;
|
|
|
|
/** Closes the connection.
|
|
* Owners of an EthernetConnection are expected to delete it when
|
|
* finished with the connection.
|
|
* The destructor will close the connection and free any
|
|
* per-connection resources.
|
|
*/
|
|
virtual ~EthernetConnection()
|
|
{
|
|
}
|
|
|
|
/** Sends a packet through the connection.
|
|
* This function makes no guarantees as to whether the packet actually
|
|
* gets stored or sent anywhere. Errors are not propagated from
|
|
* the concrete implementation of the connection.
|
|
* This matches the lossy nature of sending packets through hardware.
|
|
* @param packet A pointer to bytes of an Ethernet frame
|
|
* @param size The size (in bytes) of the Ethernet frame
|
|
*/
|
|
virtual void SendPacket(const uint8_t* packet, int size) = 0;
|
|
|
|
/** Gets all pending packets from the connection.
|
|
* This function passes each pending packet to the callback function.
|
|
* The callback provides a pointer to the bytes of an Ethernet frame,
|
|
* and the size (in bytes) of the Ethernet frame.
|
|
* Using a lambda for std::function allows easy looping over GetPackets
|
|
* instead of jumping around between functions and sharing global state.
|
|
* This function does not define the state of the packet data outside
|
|
* the callback. Copy the packet data if you need to use it later.
|
|
* @param callback The function called for each pending packet
|
|
*/
|
|
virtual void GetPackets(std::function<void(const uint8_t*, int)> callback) = 0;
|
|
};
|
|
|
|
/** Opens a virtual Ethernet connection to a backend.
|
|
* This function will try to create a new EthernetConnection based on whichever
|
|
* implementation is most appropriate for the backend requested.
|
|
* Each connection returned acts independently of other connections and is
|
|
* suitable for use with multiple network adapters.
|
|
* It will attempt to initialize the connection and return a pointer to it.
|
|
* On failure (whether after creating a connection or if no backend is found)
|
|
* this function will clean up after itself and return nullptr.
|
|
* @param backend The name of the connection backend
|
|
* @return An initialized Ethernet connection, nullptr otherwise
|
|
*/
|
|
EthernetConnection* OpenEthernetConnection(std::string backendstr);
|
|
|
|
#endif
|