DongEun Koak / NetworkSocketAPI

NetworkSocketAPI

Dependencies:   DnsQuery

Dependents:   HelloWizFi250Interface

Fork of NetworkSocketAPI by NetworkSocketAPI

EthernetInterface.h@63:531f4c27f360, 2016-03-09 (annotated)

Committer:
sam_grove
Date:
Wed Mar 09 05:51:38 2016 +0000
Revision:
63:531f4c27f360
Parent:
41:3ec1c97e9bbf 
update formatting and add comments for documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sam_grove 18:dd05ebdd2546 1 /* EthernetInterface Base Class
sam_grove 18:dd05ebdd2546 2 * Copyright (c) 2015 ARM Limited
sam_grove 18:dd05ebdd2546 3 *
sam_grove 18:dd05ebdd2546 4 * Licensed under the Apache License, Version 2.0 (the "License");
sam_grove 18:dd05ebdd2546 5 * you may not use this file except in compliance with the License.
sam_grove 18:dd05ebdd2546 6 * You may obtain a copy of the License at
sam_grove 18:dd05ebdd2546 7 *
sam_grove 18:dd05ebdd2546 8 * http://www.apache.org/licenses/LICENSE-2.0
sam_grove 18:dd05ebdd2546 9 *
sam_grove 18:dd05ebdd2546 10 * Unless required by applicable law or agreed to in writing, software
sam_grove 18:dd05ebdd2546 11 * distributed under the License is distributed on an "AS IS" BASIS,
sam_grove 18:dd05ebdd2546 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
sam_grove 18:dd05ebdd2546 13 * See the License for the specific language governing permissions and
sam_grove 18:dd05ebdd2546 14 * limitations under the License.
sam_grove 18:dd05ebdd2546 15 */
sam_grove 18:dd05ebdd2546 16
Christopher Haster 21:35ed15069189 17 #ifndef ETHERNET_INTERFACE_H
Christopher Haster 21:35ed15069189 18 #define ETHERNET_INTERFACE_H
sam_grove 18:dd05ebdd2546 19
sam_grove 18:dd05ebdd2546 20 #include "NetworkInterface.h"
sam_grove 18:dd05ebdd2546 21
Christopher Haster 21:35ed15069189 22 /** EthernetInterface class
Christopher Haster 21:35ed15069189 23 * Common interface that is shared between ethernet hardware
sam_grove 18:dd05ebdd2546 24 */
sam_grove 18:dd05ebdd2546 25 class EthernetInterface : public NetworkInterface
sam_grove 18:dd05ebdd2546 26 {
sam_grove 18:dd05ebdd2546 27 public:
Christopher Haster 21:35ed15069189 28 /** Start the interface
Christopher Haster 21:35ed15069189 29 * @return 0 on success
Christopher Haster 21:35ed15069189 30 */
Christopher Haster 41:3ec1c97e9bbf 31 virtual int32_t connect() = 0;
Christopher Haster 21:35ed15069189 32
Christopher Haster 21:35ed15069189 33 /** Stop the interface
Christopher Haster 21:35ed15069189 34 * @return 0 on success
Christopher Haster 21:35ed15069189 35 */
Christopher Haster 21:35ed15069189 36 virtual int32_t disconnect() = 0;
sam_grove 18:dd05ebdd2546 37 };
sam_grove 18:dd05ebdd2546 38
sam_grove 18:dd05ebdd2546 39 #endif