NetworkSocketAPI
Dependents: HelloWizFi250Interface
Fork of NetworkSocketAPI by
EthernetInterface.h@118:96627c4b83d5, 2016-04-20 (annotated)
- Committer:
- Christopher Haster
- Date:
- Wed Apr 20 20:38:00 2016 -0500
- Revision:
- 118:96627c4b83d5
- Parent:
- 114:964eba6394bc
Fix for timeout issue with WFI
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Christopher Haster |
113:80ba92c5e5ca | 1 | /* EthernetInterface |
Christopher Haster |
113:80ba92c5e5ca | 2 | * Copyright (c) 2015 ARM Limited |
Christopher Haster |
113:80ba92c5e5ca | 3 | * |
Christopher Haster |
113:80ba92c5e5ca | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
Christopher Haster |
113:80ba92c5e5ca | 5 | * you may not use this file except in compliance with the License. |
Christopher Haster |
113:80ba92c5e5ca | 6 | * You may obtain a copy of the License at |
Christopher Haster |
113:80ba92c5e5ca | 7 | * |
Christopher Haster |
113:80ba92c5e5ca | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
Christopher Haster |
113:80ba92c5e5ca | 9 | * |
Christopher Haster |
113:80ba92c5e5ca | 10 | * Unless required by applicable law or agreed to in writing, software |
Christopher Haster |
113:80ba92c5e5ca | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
Christopher Haster |
113:80ba92c5e5ca | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
Christopher Haster |
113:80ba92c5e5ca | 13 | * See the License for the specific language governing permissions and |
Christopher Haster |
113:80ba92c5e5ca | 14 | * limitations under the License. |
Christopher Haster |
113:80ba92c5e5ca | 15 | */ |
Christopher Haster |
113:80ba92c5e5ca | 16 | |
Christopher Haster |
113:80ba92c5e5ca | 17 | #ifndef ETHERNET_INTERFACE_H |
Christopher Haster |
113:80ba92c5e5ca | 18 | #define ETHERNET_INTERFACE_H |
Christopher Haster |
113:80ba92c5e5ca | 19 | |
Christopher Haster |
113:80ba92c5e5ca | 20 | #include "NetworkStack.h" |
Christopher Haster |
113:80ba92c5e5ca | 21 | |
Christopher Haster |
113:80ba92c5e5ca | 22 | /** EthernetInterface class |
Christopher Haster |
113:80ba92c5e5ca | 23 | * |
Christopher Haster |
113:80ba92c5e5ca | 24 | * Common interface that is shared between ethernet hardware. |
Christopher Haster |
113:80ba92c5e5ca | 25 | */ |
Christopher Haster |
113:80ba92c5e5ca | 26 | class EthernetInterface |
Christopher Haster |
113:80ba92c5e5ca | 27 | { |
Christopher Haster |
113:80ba92c5e5ca | 28 | public: |
Christopher Haster |
113:80ba92c5e5ca | 29 | /** Start the interface |
Christopher Haster |
113:80ba92c5e5ca | 30 | * |
Christopher Haster |
113:80ba92c5e5ca | 31 | * @return 0 on success, negative error code on failure |
Christopher Haster |
113:80ba92c5e5ca | 32 | */ |
Christopher Haster |
113:80ba92c5e5ca | 33 | virtual int connect() = 0; |
Christopher Haster |
113:80ba92c5e5ca | 34 | |
Christopher Haster |
113:80ba92c5e5ca | 35 | /** Stop the interface |
Christopher Haster |
113:80ba92c5e5ca | 36 | * |
Christopher Haster |
113:80ba92c5e5ca | 37 | * @return 0 on success, negative error code on failure |
Christopher Haster |
113:80ba92c5e5ca | 38 | */ |
Christopher Haster |
113:80ba92c5e5ca | 39 | virtual int disconnect() = 0; |
Christopher Haster |
114:964eba6394bc | 40 | |
Christopher Haster |
114:964eba6394bc | 41 | /** Get the local MAC address |
Christopher Haster |
114:964eba6394bc | 42 | * |
Christopher Haster |
114:964eba6394bc | 43 | * @return Null-terminated representation of the local MAC address |
Christopher Haster |
114:964eba6394bc | 44 | */ |
Christopher Haster |
114:964eba6394bc | 45 | virtual const char *get_mac_address() = 0; |
Christopher Haster |
113:80ba92c5e5ca | 46 | }; |
Christopher Haster |
113:80ba92c5e5ca | 47 | |
Christopher Haster |
113:80ba92c5e5ca | 48 | #endif |