Many, many changes. Documentation changes, renamed the socket class to

TcpSocket, fixed many other things, and finally removed ParamProc.  Anything
that needs it will now have to switch to OptParser.

1 files changed, 116 insertions, 0 deletions

diff --git a/src/tcpsocket.h b/src/tcpsocket.h
new file mode 100644
index 0000000..3361e84
--- /dev/null
+++ b/src/tcpsocket.h
@@ -0,0 +1,116 @@
+/*
+ * Copyright (C) 2007-2010 Xagasoft, All rights reserved.
+ *
+ * This file is part of the libbu++ library and is released under the
+ * terms of the license contained in the file LICENSE.
+ */
+
+#ifndef BU_TCP_SOCKET_H
+#define BU_TCP_SOCKET_H
+
+#include <stdint.h>
+
+#include "bu/stream.h"
+#include "bu/fstring.h"
+#include "bu/exceptionbase.h"
+
+namespace Bu
+{
+        subExceptionDeclBegin( TcpSocketException );
+                enum {
+                        cRead,
+                        cWrite,
+                        cBadRead,
+                        cClosed,
+                        cTimeout
+                };
+        subExceptionDeclEnd();
+
+        /**
+         * Network socket stream class.  This class provides a mechanism for
+         * communicating over a network using TCP/IP.  It will provide other low
+         * level protocol and addressing support later on, but for now it's just
+         * standard STREAM TCP/IP sockets.
+         *
+         * Unlike system sockets, these sockets are opened by default in
+         * non-blocking mode, you can specify your own timeout for opening a socket,
+         * and a number of non-fatal error messages have been automatically handled
+         * and treated as standard no-data-available-yet situations on read.
+         *
+         * Please note that there is a condition that will occur eventually (at
+         * least on *nix systems) that will trigger a SIGPIPE condition.  This
+         * will terminate your program immediately unless handled properly.  Most
+         * people doing any connections with TcpSocket will want to put this in
+         * their program somewhere before they use it:
+         *@code
+         #include <signal.h>
+         ...
+         ...
+         ...
+         sigset( SIGPIPE, SIG_IGN ); // do this before you use a Bu::TcpSocket
+         @endcode
+         * When this is done, Bu::TcpSocket will simply throw a broken pipe
+         * exception just like every other error condition, allowing your program
+         * to handle it sanely.
+         *
+         *@ingroup Serving
+         *@ingroup Streams
+         */
+        class TcpSocket : public Stream
+        {
+        public:
+                TcpSocket( int nTcpSocket );
+                TcpSocket( const FString &sAddr, int nPort, int nTimeout=30,
+                                bool bBlocking=true );
+                virtual ~TcpSocket();
+                
+                virtual void close();
+                //virtual void read();
+                virtual size_t read( void *pBuf, size_t nBytes );
+                virtual size_t read( void *pBuf, size_t nBytes,
+                                uint32_t nSec, uint32_t nUSec=0 );
+                virtual size_t write( const void *pBuf, size_t nBytes );
+                virtual size_t write( const void *pBuf, size_t nBytes,
+                                uint32_t nSec, uint32_t nUSec=0 );
+                using Stream::write;
+
+                virtual long tell();
+                virtual void seek( long offset );
+                virtual void setPos( long pos );
+                virtual void setPosEnd( long pos );
+                virtual bool isEos();
+                virtual bool isOpen();
+
+                virtual void flush();
+
+                virtual bool canRead();
+                virtual bool canWrite();
+
+                virtual bool isReadable();
+                virtual bool isWritable();
+                virtual bool isSeekable();
+
+                virtual bool isBlocking();
+                virtual void setBlocking( bool bBlocking=true );
+
+                virtual void setSize( long iSize );
+
+                Bu::FString getAddress() const;
+                operator int() const;
+
+        private:
+                void setAddress();
+
+#ifdef WIN32
+                unsigned int nTcpSocket;
+#else
+                int nTcpSocket;
+#endif
+                bool bActive;
+                bool bBlocking;
+                FString sReadBuf;
+                FString sAddress;
+        };
+}
+
+#endif