NetworkSocketAPI
Dependents: HelloWizFi250Interface
Fork of NetworkSocketAPI by
Diff: EthernetInterface.h
- Revision:
- 104:d28d8b508e7c
- Parent:
- 89:b1d417383c0d
--- a/EthernetInterface.h Tue Apr 19 18:26:12 2016 -0500 +++ b/EthernetInterface.h Tue Apr 19 18:26:21 2016 -0500 @@ -1,4 +1,4 @@ -/* Socket +/* EthernetInterface * Copyright (c) 2015 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -20,18 +20,21 @@ #include "NetworkInterface.h" /** EthernetInterface class - * Common interface that is shared between ethernet hardware + * + * Common interface that is shared between ethernet hardware. */ class EthernetInterface : public NetworkInterface { public: /** Start the interface - * @return 0 on success, negative on failure + * + * @return 0 on success, negative error code on failure */ virtual int connect() = 0; /** Stop the interface - * @return 0 on success, negative on failure + * + * @return 0 on success, negative error code on failure */ virtual int disconnect() = 0; };