EthInterface.h

00001 /* EthInterface
00002  * Copyright (c) 2015 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef ETH_INTERFACE_H
00018 #define ETH_INTERFACE_H
00019 
00020 #include "network-socket/NetworkInterface.h"
00021 
00022 
00023 /** EthInterface class
00024  *
00025  *  Common interface that is shared between ethernet hardware.
00026  */
00027 class EthInterface : public NetworkInterface
00028 {
00029 public:
00030     /** Start the interface
00031      *
00032      *  @return     0 on success, negative error code on failure
00033      */
00034     virtual int connect() = 0;
00035 
00036     /** Stop the interface
00037      *
00038      *  @return     0 on success, negative error code on failure
00039      */
00040     virtual int disconnect() = 0;
00041 
00042     /** Get the local MAC address
00043      *
00044      *  @return         Null-terminated representation of the local MAC address
00045      */
00046     virtual const char *get_mac_address() = 0;
00047 };
00048 
00049 
00050 #endif