mbed-os/features/netsocket/EthInterface.h

65 lines
1.7 KiB
C++

/** \addtogroup netsocket */
/** @{*/
/* EthInterface
* Copyright (c) 2015 ARM Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ETH_INTERFACE_H
#define ETH_INTERFACE_H
#include "netsocket/NetworkInterface.h"
/** EthInterface class
*
* Common interface that is shared between ethernet hardware.
*/
class EthInterface : public virtual NetworkInterface
{
public:
virtual EthInterface *ethInterface() {
return this;
}
/** Get the default Ethernet interface.
*
* This is provided as a weak method so applications can override.
* Default behaviour is to get the target's default interface, if
* any.
*
* @return pointer to interface, if any
*/
static EthInterface *get_default_instance();
protected:
/** Get the target's default Ethernet interface.
*
* This is provided as a weak method so targets can override. The
* default implementation will invoke EthernetInterface with the
* default EMAC and default network stack, if DEVICE_EMAC is set.
*
* @return pointer to interface, if any
*/
static EthInterface *get_target_default_instance();
};
#endif
/** @}*/