mbed official / CellularModem

Base library for cellular modem implementations

Dependencies:   Socket lwip-sys lwip

Dependents:   CellularUSBModem CellularUSBModem

Deprecated

This is an mbed 2 networking library. For mbed 5, the networking libraries have been revised to better support additional network stacks and thread safety here.

core/IOStream.h@8:944cd194963e, 2014-05-08 (annotated)

Committer:
mbed_official
Date:
Thu May 08 11:00:26 2014 +0100
Revision:
8:944cd194963e
Parent:
1:4a23efdf0da9 
Synchronized with git revision df12bf01ac7dbb50751e2b16a351c894994e1dcf



Full URL: https://github.com/mbedmicro/mbed/commit/df12bf01ac7dbb50751e2b16a351c894994e1dcf/

Who changed what in which revision?

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