tool/mbed/mbed-sdk/libraries/net/cellular/CellularModem/core/IOStream.h

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