tools/brawchannel.h

   1 ///
   2 /// \file       brawchannel.h
   3 ///             Directs a named raw channel over STDIN/STDOUT or TCP
   4 ///
   5
   6 /*
   7     Copyright (C) 2010-2012, RealVNC Ltd.
   8
   9         Some parts are inspired from bjavaloader.cc
  10
  11     This program is free software; you can redistribute it and/or modify
  12     it under the terms of the GNU General Public License as published by
  13     the Free Software Foundation; either version 2 of the License, or
  14     (at your option) any later version.
  15
  16     This program is distributed in the hope that it will be useful,
  17     but WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  19
  20     See the GNU General Public License in the COPYING file at the
  21     root directory of this project for more details.
  22 */
  23
  24 #ifndef __BARRY_TOOLS_BRAWCHANNEL_H__
  25 #define __BARRY_TOOLS_BRAWCHANNEL_H__
  26
  27 #include <sys/types.h>
  28 #include <memory>
  29 #include <string>
  30
  31 // How long, in seconds, to wait between reads before checking if should shutdown
  32 #define READ_TIMEOUT_SECONDS 1
  33
  34 /* Defined generic stream reading and writing classes.
  35  *
  36  * It'd be great to use iostream, but they don't provide non-blocking reads.
  37  */
  38 class Stream {
  39 public:
  40         virtual ~Stream() {};
  41 };
  42
  43 class InputStream {
  44 public:
  45         virtual ~InputStream() {};
  46         virtual ssize_t read(unsigned char* ptr, size_t size, int timeout) = 0;
  47 };
  48
  49 class OutputStream {
  50 public:
  51         virtual ~OutputStream() {};
  52         virtual ssize_t write(const unsigned char* ptr, size_t size) = 0;
  53 };
  54
  55 class StdOutStream : public OutputStream {
  56 public:
  57         virtual ssize_t write(const unsigned char* ptr, size_t size);
  58 };
  59
  60 class StdInStream : public InputStream {
  61 public:
  62         virtual ssize_t read(unsigned char* ptr, size_t size, int timeout);
  63 };
  64
  65 // Forward declaration of platform implementation details
  66 struct TcpStreamImpl;
  67
  68 class TcpStream : public Stream {
  69 public:
  70         std::auto_ptr<TcpStreamImpl> mImpl;
  71 public:
  72         TcpStream(const std::string& addr, long port);
  73         ~TcpStream();
  74         bool accept();
  75 };
  76
  77 class TcpInStream : public InputStream {
  78 private:
  79         TcpStream& mStream;
  80 public:
  81         TcpInStream(TcpStream& stream)
  82                 : mStream(stream) {}
  83         virtual ssize_t read(unsigned char* ptr, size_t size, int timeout);
  84 };
  85
  86 class TcpOutStream : public OutputStream {
  87 private:
  88         TcpStream& mStream;
  89 public:
  90         TcpOutStream(TcpStream& stream)
  91                 : mStream(stream) {}
  92 public:
  93         virtual ssize_t write(const unsigned char* ptr, size_t size);
  94 };
  95
  96 #endif // __BARRY_TOOLS_BRAWCHANNEL_H__