summaryrefslogtreecommitdiff
path: root/lib/psocksxx/iosockstream.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/psocksxx/iosockstream.h')
-rw-r--r--lib/psocksxx/iosockstream.h79
1 files changed, 79 insertions, 0 deletions
diff --git a/lib/psocksxx/iosockstream.h b/lib/psocksxx/iosockstream.h
new file mode 100644
index 0000000..2b2b0bb
--- /dev/null
+++ b/lib/psocksxx/iosockstream.h
@@ -0,0 +1,79 @@
+/*
+* psocksxx - A C++ wrapper for POSIX sockets
+* Copyright (C) 2013 Uditha Atukorala
+*
+* This software library is free software; you can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published by
+* the Free Software Foundation; either version 3 of the License, or
+* (at your option) any later version.
+*
+* This software library 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 Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with this software library. If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+#ifndef PSOCKSXX_IOSOCKSTREAM_H
+#define PSOCKSXX_IOSOCKSTREAM_H
+
+#include <psocksxx/isockstream.h>
+#include <psocksxx/osockstream.h>
+
+
+namespace psocksxx {
+
+ /**
+ * @brief Input and Output controller class for socket streams
+ *
+ * This merges the two input and output controller
+ * classes to create a single interface for controlling
+ * both input and output socket streams.
+ *
+ */
+ class iosockstream :
+ public isockstream,
+ public osockstream {
+
+ public:
+
+ /**
+ * @brief constructor
+ * @param ssb socket stream buffer
+ *
+ * This constructor simply initialises the parent
+ * classes with the passed in socket stream buffer
+ */
+ iosockstream( sockstreambuf * ssb ) throw() :
+ isockstream( ssb ), osockstream( ssb ) {
+ // constructor
+ }
+
+ /**
+ * @brief destructor
+ */
+ virtual ~iosockstream() throw() {
+ // destructor
+ }
+
+ /**
+ * @brief get the timed-out status for this stream
+ * @return boolean @c true if timed-out flag is set or @c false
+ * otherwise.
+ *
+ * Returns the timed-out status.
+ *
+ */
+ bool timedout() const throw() {
+ return ( isockstream::timedout() || osockstream::timedout() );
+ }
+
+ };
+
+} /* end of namespace psocksxx */
+
+#endif /* !PSOCKSXX_IOSOCKSTREAM_H */
+