Donatien Garnier / LwIPNetworking

Core networking libraries including LwIP implementation

Dependencies:   DebugLib Socket lwip lwip-sys

Dependents:   EthernetInterface

Fork of NetworkingCoreLib by Donatien Garnier

main/core/IOStream.h@15:cf5f669a30bc, 2012-06-22 (annotated)

Committer:
donatien
Date:
Fri Jun 22 16:18:09 2012 +0000
Revision:
15:cf5f669a30bc
Parent:
13:f7d8c8088289 
DebugLib up

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:013f5d54248c 1 /* IOStream.h */
donatien 13:f7d8c8088289 2 /* Copyright (C) 2012 mbed.org, MIT License
donatien 13:f7d8c8088289 3 *
donatien 13:f7d8c8088289 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 13:f7d8c8088289 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
donatien 13:f7d8c8088289 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
donatien 13:f7d8c8088289 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
donatien 13:f7d8c8088289 8 * furnished to do so, subject to the following conditions:
donatien 13:f7d8c8088289 9 *
donatien 13:f7d8c8088289 10 * The above copyright notice and this permission notice shall be included in all copies or
donatien 13:f7d8c8088289 11 * substantial portions of the Software.
donatien 13:f7d8c8088289 12 *
donatien 13:f7d8c8088289 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 13:f7d8c8088289 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 13:f7d8c8088289 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 13:f7d8c8088289 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 13:f7d8c8088289 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 13:f7d8c8088289 18 */
donatien 0:013f5d54248c 19
donatien 0:013f5d54248c 20 #ifndef IOSTREAM_H_
donatien 0:013f5d54248c 21 #define IOSTREAM_H_
donatien 0:013f5d54248c 22
donatien 0:013f5d54248c 23 #include "fwk.h"
donatien 0:013f5d54248c 24
donatien 0:013f5d54248c 25 #include "rtos.h"
donatien 0:013f5d54248c 26
donatien 0:013f5d54248c 27 class IStream
donatien 0:013f5d54248c 28 {
donatien 0:013f5d54248c 29 public:
donatien 0:013f5d54248c 30 //IStream();
donatien 0:013f5d54248c 31 //virtual ~IStream();
donatien 0:013f5d54248c 32
donatien 13:f7d8c8088289 33 //0 for non-blocking (returns immediately), osWaitForever for infinite blocking
donatien 13:f7d8c8088289 34 virtual int read(uint8_t* buf, size_t* pLength, size_t maxLength, uint32_t timeout=osWaitForever) = 0;
donatien 13:f7d8c8088289 35 virtual size_t available() = 0;
donatien 13:f7d8c8088289 36 virtual int waitAvailable(uint32_t timeout=osWaitForever) = 0; //Wait for data to be available
donatien 13:f7d8c8088289 37 virtual int abortRead() = 0; //Abort current reading (or waiting) operation
donatien 0:013f5d54248c 38 };
donatien 0:013f5d54248c 39
donatien 0:013f5d54248c 40 class OStream
donatien 0:013f5d54248c 41 {
donatien 0:013f5d54248c 42 public:
donatien 0:013f5d54248c 43 //OStream();
donatien 0:013f5d54248c 44 //virtual ~OStream();
donatien 0:013f5d54248c 45
donatien 13:f7d8c8088289 46 //0 for non-blocking (returns immediately), osWaitForever for infinite blocking
donatien 13:f7d8c8088289 47 virtual int write(uint8_t* buf, size_t length, uint32_t timeout=osWaitForever) = 0;
donatien 13:f7d8c8088289 48 virtual size_t space() = 0;
donatien 13:f7d8c8088289 49 virtual int waitSpace(uint32_t timeout=osWaitForever) = 0; //Wait for space to be available
donatien 13:f7d8c8088289 50 virtual int abortWrite() = 0; //Abort current writing (or waiting) operation
donatien 0:013f5d54248c 51 };
donatien 0:013f5d54248c 52
donatien 0:013f5d54248c 53 class IOStream : public IStream, public OStream
donatien 0:013f5d54248c 54 {
donatien 0:013f5d54248c 55 public:
donatien 0:013f5d54248c 56 //IOStream();
donatien 0:013f5d54248c 57 //virtual ~IOStream();
donatien 0:013f5d54248c 58 };
donatien 0:013f5d54248c 59
donatien 0:013f5d54248c 60
donatien 0:013f5d54248c 61 #endif /* IOSTREAM_H_ */