summaryrefslogtreecommitdiff
path: root/lib/psocksxx/nsockstream.h
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2014-10-01 08:07:52 +0200
committerJörg Frings-Fürst <debian@jff-webhosting.net>2014-10-01 08:07:52 +0200
commit6c4f0aa3eaa0de86457dbc734ea552cd03a67a0d (patch)
tree3a5d5161046f3c97d9a18bd16285a807a20c2466 /lib/psocksxx/nsockstream.h
Initial import of psocksxx version 0.0.5-1
Diffstat (limited to 'lib/psocksxx/nsockstream.h')
-rw-r--r--lib/psocksxx/nsockstream.h143
1 files changed, 143 insertions, 0 deletions
diff --git a/lib/psocksxx/nsockstream.h b/lib/psocksxx/nsockstream.h
new file mode 100644
index 0000000..9d7e5a2
--- /dev/null
+++ b/lib/psocksxx/nsockstream.h
@@ -0,0 +1,143 @@
+/*
+* 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_NSOCKSTREAM_H
+#define PSOCKSXX_NSOCKSTREAM_H
+
+#include <psocksxx/iosockstream.h>
+#include <psocksxx/nsockaddr.h>
+
+
+namespace psocksxx {
+
+ /**
+ * @brief Network (IPv4) controller class
+ *
+ * This is the base class for network (IP version 4)
+ * communications streams.
+ *
+ */
+ class nsockstream : public iosockstream {
+ public:
+
+ /**
+ * @brief constructor
+ * @param type socket communications type
+ * @param proto socket communications protocol
+ * @throw psocksxx::sockexception socket exception
+ *
+ * Open a network (IPv4) communications stream with the
+ * passed in type and protocol.
+ */
+ nsockstream( sockstreambuf::socket_type_t type, sockstreambuf::socket_protocol_t proto ) throw( sockexception );
+
+ /**
+ * @brief constructor
+ * @param ssb initialised socket stream buffer instance
+ *
+ * Initialise a network socket stream by using the passed in
+ * socket stream buffer, @c ssb, as the associated sequence
+ * which is assumed to be initialised with the correct type
+ * and protocol. The class destructor will delete the psocksxx::sockstreambuf
+ * instance pointed by @c ssb.
+ *
+ */
+ nsockstream( sockstreambuf * ssb ) throw();
+
+ /**
+ * @brief destructor
+ */
+ virtual ~nsockstream() throw();
+
+ /**
+ * @brief connect to a network address
+ * @param saddr destination address information
+ * @throw psocksxx::sockexception socket exception
+ * @throw psocksxx::socktimeoutexception connection timeout
+ * exception
+ *
+ * Connect to a IPv4 communication end point making this stream
+ * ready for I/O.
+ *
+ */
+ void connect( const nsockaddr * saddr ) throw( sockexception, socktimeoutexception );
+
+ /**
+ * @brief connect to a network address
+ * @param node node (host name or IP)
+ * @param port port number
+ * @throw psocksxx::sockexception socket exception
+ * @throw psocksxx::socktimeoutexception connection timeout
+ * exception
+ *
+ * Connect to a IPv4 communication end point making this stream
+ * ready for I/O.
+ *
+ */
+ void connect( const char * node, unsigned int port ) throw( sockexception, socktimeoutexception );
+
+ /**
+ * @brief bind the stream to a network address
+ * @param saddr address information to bind to
+ * @param reuse_addr allow address to be re-used
+ * @throw psocksxx::sockexception socket exception
+ *
+ * This binds the network socket stream to the specified network
+ * address. If you want to try to bind to any socket that is not
+ * actively listening (e.g. TIME_WAIT) then set the @c reuse_addr
+ * parameter to be @c true.
+ *
+ */
+ void bind( const nsockaddr * saddr, bool reuse_addr = false ) throw( sockexception );
+
+ /**
+ * @brief make this stream passive and ready to accept connections
+ * @param backlog maximum length of the queue for pending connections
+ * and if this value is 0 (default) then it assumes
+ * system default
+ *
+ * @throw psocksxx::sockexception socket exception
+ *
+ * Make this network stream passive and ready to accept connections.
+ * Before calling this method the stream must be bound to a
+ * network address using the bind() method.
+ *
+ */
+ void listen( int backlog = 0 ) throw( sockexception );
+
+ /**
+ * @brief accept a connection on a listening (passive) stream
+ * @throw psocksxx::sockexception socket exception
+ * @return a new stream instance for the accepted connection
+ *
+ * This method will accept an incoming connection on a listening
+ * stream and return a newly created stream instance that can
+ * be used to communicate with the accepted client connection.
+ * Note that the returned stream instance must be deleted by the
+ * caller.
+ *
+ */
+ nsockstream * accept() throw( sockexception );
+
+ };
+
+} /* end of namespace psocksxx */
+
+#endif /* !PSOCKSXX_NSOCKSTEAM_H */
+