summaryrefslogtreecommitdiffhomepage
path: root/digital/ucoolib/ucoolib/intf/stream.hh
blob: c6912141260ab538d5d874fb5c7a5572fe902304 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
#ifndef ucoolib_intf_stream_hh
#define ucoolib_intf_stream_hh
// ucoolib - Microcontroller object oriented library. {{{
//
// Copyright (C) 2012 Nicolas Schodet
//
// APBTeam:
//        Web: http://apbteam.org/
//      Email: team AT apbteam DOT org
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// }}}

namespace ucoo {

/// Interface to an object providing a stream oriented flow, like serial port,
/// connected socket, or higher encapsulated protocol.
class Stream
{
  public:
    /// Set whether operations on this stream should block when no data is
    /// available.
    virtual void block (bool block = true);
    /// Read up to COUNT bytes of data from stream and store them in BUF.
    /// Return the number of read bytes, -1 on error or -2 on EOF.
    ///
    /// If blocking, will return as soon as there is some data available.  If
    /// not blocking, may return 0 if no data is available.
    virtual int read (char *buf, int count) = 0;
    /// Write up to COUNT bytes of data from BUF to stream.  Return the number
    /// of written bytes or -1 on error.
    ///
    /// If blocking, will try its best to write all data provided.
    virtual int write (const char *buf, int count) = 0;
    /// Shortcut to read one character.  Return -1 on error, on EOF, or if no
    /// character is available.
    int getc ();
    /// Shortcut to write one character.  Return -1 on error.
    int putc (int c);
  protected:
    /// Default constructor.
    Stream ();
  protected:
    /// Current blocking operation flag.
    bool block_;
};

} // namespace ucoo

#endif // ucoolib_intf_stream_hh