include/log4cxx/helpers/socketimpl.h

/***************************************************************************
                          socketimpl.h  -  class SocketImpl
                             -------------------
    begin                : ven mai 9 2003
    copyright            : (C) 2003 by Michael CATANZARITI
    email                : mcatan@free.fr
 ***************************************************************************/

/***************************************************************************
 * Copyright (C) The Apache Software Foundation. All rights reserved.      *
 *                                                                         *
 * This software is published under the terms of the Apache Software       *
 * License version 1.1, a copy of which has been included with this        *
 * distribution in the LICENSE.txt file.                                   *
 ***************************************************************************/

#ifndef _LOG4CXX_HELPERS_SOCKET_IMPL
#define _LOG4CXX_HELPERS_SOCKET_IMPL

#include <log4cxx/helpers/objectimpl.h>
#include <log4cxx/helpers/objectptr.h>
#include <log4cxx/helpers/inetaddress.h>
#include <log4cxx/helpers/exception.h>

namespace log4cxx
{
	namespace helpers
	{
		class IOException : public Exception
		{
		public:
			tstring getMessage() { return tstring(); }
		};

		class SocketException : public IOException
		{
		public:
			SocketException();
			tstring getMessage();

		protected:
			tstring message;
		};

		class ConnectException : public SocketException
		{
		};

		class BindException : public SocketException
		{
		};

		class InterruptedIOException : public IOException
		{
			tstring getMessage() { return tstring(); }
		};

		class SocketImpl;
		typedef helpers::ObjectPtr<SocketImpl> SocketImplPtr;

		class SocketImpl : public helpers::ObjectImpl


		{
		protected:
			/** The IP address of the remote end of this socket. */
			InetAddress address;

			/** The file descriptor object for this socket. */
			int fd;

			/** The local port number to which this socket is connected. */
			int localport;

			/** The port number on the remote host to which
			this socket is connected. */
			int port;

			int timeout;

		public:
			SocketImpl();
			~SocketImpl();
			
			/** Accepts a connection. */
			void accept(SocketImplPtr s);

			/** Returns the number of bytes that can be read from this socket
			without blocking.
			*/
			int available();

			/** Binds this socket to the specified port number
			on the specified host.
			*/
			void bind(InetAddress host, int port);

			/** Closes this socket. */
			void close();

			/**  Connects this socket to the specified port number
			on the specified host.
			*/
 			void connect(InetAddress address, int port);

			/** Connects this socket to the specified port on the named host. */
			void connect(const tstring& host, int port);

			/** Creates either a stream or a datagram socket. */
			void create(bool stream);

			/** Returns the value of this socket's fd field. */
			inline int getFileDescriptor() const
				{ return fd; }

			/** Returns the value of this socket's address field. */
			inline InetAddress getInetAddress() const
				{ return address; }

			/** Returns the value of this socket's localport field. */
			inline int getLocalPort() const
				{ return localport; }

			/** Returns the value of this socket's port field. */
			inline int getPort() const
				{ return port; }

			/** Sets the maximum queue length for incoming connection
			indications (a request to connect) to the count argument.
			*/
			void listen(int backlog);

			/** Returns the address and port of this socket as a String.
			*/
			tstring toString() const;

			size_t read(void * buf, size_t len);
			size_t write(const void * buf, size_t len);

			/** Retrive setting for SO_TIMEOUT.
			*/
			int getSoTimeout();

			/** Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds.
			*/
			void setSoTimeout(int timeout);
		};
	}; // namespace helpers
}; // namespace log4cxx

#endif // _LOG4CXX_HELPERS_SOCKET_IMPL