Update TimeDelta to timeval conversion

[libs/net.git] / source / socket.h

diff --git a/source/socket.h b/source/socket.h
index db4206cb7546a5f84e7345035def471a3b09c0e5..a2cbae1a285ded03a645b377b3e2a85188213664 100644 (file)
--- a/source/socket.h
+++ b/source/socket.h
@@ -1,10 +1,3 @@
-/* $Id$
-
-This file is part of libmspnet
-Copyright © 2008  Mikkosoft Productions, Mikko Rasa
-Distributed under the LGPL
-*/
-
 #ifndef MSP_NET_SOCKET_H_
 #define MSP_NET_SOCKET_H_
 
@@ -23,9 +16,9 @@ protected:
 #ifdef WIN32
        IO::Handle event;
 #endif
-       bool       connected;
-       SockAddr   *local_addr;
-       SockAddr   *peer_addr;
+       bool connected;
+       SockAddr *local_addr;
+       SockAddr *peer_addr;
 
        Socket(SocketHandle, const SockAddr &);
        Socket(Family, int, int);
@@ -36,9 +29,18 @@ public:
        IO::Handle get_event_handle();
 
        bool is_connected() const { return connected; }
+       
+       /** Associates the socket with a local address.  There must be no existing
+       users of the address. */
        void bind(const SockAddr &);
-       virtual int connect(const SockAddr &) =0;
+
+       /** Connects to a remote address.  Exact semantics depend on the socket
+       type. */
+       virtual int connect(const SockAddr &) = 0;
+
+       /// Closes the socket.  Most operations will throw an exception after this.
        void close();
+
        void set_timeout(const Time::TimeDelta &);
        const SockAddr &get_local_address() const;
        const SockAddr &get_peer_address() const;