summaryrefslogtreecommitdiff
path: root/server/src/tcpsocket.h
diff options
context:
space:
mode:
Diffstat (limited to 'server/src/tcpsocket.h')
-rw-r--r--server/src/tcpsocket.h183
1 files changed, 183 insertions, 0 deletions
diff --git a/server/src/tcpsocket.h b/server/src/tcpsocket.h
new file mode 100644
index 0000000..f392a2c
--- /dev/null
+++ b/server/src/tcpsocket.h
@@ -0,0 +1,183 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/***************************************************************************
+ * tcpsocket.h
+ *
+ * Thu Oct 19 10:24:25 CEST 2006
+ * Copyright 2006 Bent Bisballe Nyeng
+ * deva@aasimon.org
+ ****************************************************************************/
+
+/*
+ * This file is part of Artefact.
+ *
+ * Artefact 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.
+ *
+ * Artefact 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 Artefact; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+ */
+#ifndef __ARTEFACT_TCPSOCKET_H__
+#define __ARTEFACT_TCPSOCKET_H__
+
+#include <string>
+
+#include "exception.h"
+
+namespace Pentominos {
+
+ /**
+ * This exception is thrown by TCPSocket when the socket creation fails.
+ */
+ class TCPSocketException: public Pentominos::Exception {
+ public:
+ TCPSocketException(std::string reason) :
+ Pentominos::Exception("Could not create socket: " + reason) {}
+ };
+
+ /**
+ * This exception is thrown by TCPSocket when listen fails.
+ */
+ class TCPListenException: public Pentominos::Exception {
+ public:
+ TCPListenException(std::string reason) :
+ Pentominos::Exception("Listen failed: " + reason) {}
+ };
+
+ /**
+ * This exception is thrown by TCPSocket when accept fails.
+ */
+ class TCPAcceptException: public Pentominos::Exception {
+ public:
+ TCPAcceptException(std::string reason) :
+ Pentominos::Exception("Accept failed: " + reason) {}
+ };
+
+ /**
+ * This exception is thrown by TCPSocket when connection fails.
+ */
+ class TCPConnectException: public Pentominos::Exception {
+ public:
+ TCPConnectException(std::string host, std::string port, std::string reason) :
+ Pentominos::Exception("Could not connect to " + host + ":" + port + ": " + reason) {}
+ };
+
+ /**
+ * This exception is thrown by TCPSocket when reading fails.
+ */
+ class TCPReadException: public Pentominos::Exception {
+ public:
+ TCPReadException(std::string reason) :
+ Pentominos::Exception("TCPSocket could not read data: " + reason) {}
+ };
+
+ /**
+ * This exception is thrown by TCPSocket when writing fails.
+ */
+ class TCPWriteException: public Pentominos::Exception {
+ public:
+ TCPWriteException(std::string reason) :
+ Pentominos::Exception("TCPSocket could not write data: " + reason) {}
+ };
+
+ /**
+ * This exception is thrown by TCPSocket when there is an error in name lookup.
+ */
+ class TCPNameException: public Pentominos::Exception {
+ public:
+ TCPNameException(std::string reason) :
+ Pentominos::Exception("TCPSocket could not get name: " + reason) {}
+ };
+
+ /**
+ * This class is used to commumicate through a TCP/IP connection, wether it
+ * is a server (listening) or a client (transmitting).
+ */
+ class TCPSocket {
+ public:
+ /**
+ * Constructor. Creates a new tcp socket.
+ */
+ TCPSocket() throw(TCPSocketException);
+
+ /**
+ * Destructor. Closes the tcp socket.
+ */
+ ~TCPSocket();
+
+ /**
+ * Sets the socket in listen mode.\n
+ * @param port The port number on which to listen.
+ */
+ void listen(unsigned short int port) throw(TCPListenException);
+
+ /**
+ * Accept an incoming connection.\n
+ * The call is blocking and returns only when an incoming connection is received.\n
+ * The socket must be in listen mode in order for this call to work.\n
+ * Multiple accepts can be made on the same listening socket.
+ * @return A connected TCPSocket ready to communicate.
+ */
+ TCPSocket accept() throw(TCPAcceptException);
+
+ /**
+ * Connects to a host for data transmission.
+ * @param addr The address of the host to connect to.
+ * @param port The portnumber of the host to connect to.
+ */
+ void connect(std::string addr, unsigned short int port) throw(TCPConnectException);
+
+ /**
+ * Disconnect the socket.
+ */
+ void disconnect();
+
+ /**
+ * Tells whether the socket is connected or not.
+ * @return true if the socket is connected, false if not.
+ */
+ bool connected();
+
+ /**
+ * Reads bytes from the socket into a buffer.
+ * @param buf The buffer into which the data will be written.
+ * @param size The maximum number of bytes to read in (the size of the buffer).
+ * @return The actual number of bytes read.
+ */
+ int read(char *buf, int size) throw(TCPReadException);
+
+ /**
+ * Writes bytes from a buffer to the socket.
+ * @param data The buffer from which the data will be read.
+ * @param size The number of bytes to write.
+ * @return The actual number of bytes written.
+ */
+ int write(char *data, int size) throw(TCPWriteException);
+
+ /**
+ * Get the source address of the socket (IP address not DNS name).
+ * @return An STL string containing the source address.
+ */
+ std::string srcaddr() throw(TCPNameException);
+
+ /**
+ * Get the destination address of the socket (IP address not DNS name).
+ * @return An STL string containing the destination address.
+ */
+ std::string dstaddr() throw(TCPNameException);
+
+ private:
+ bool isconnected;
+ int sock;
+ };
+
+};
+
+#endif/*__ARTEFACT_TCPSOCKET_H__*/