src/node/socket-factory.h
changeset 2179 9b58bef0a7ff
parent 748 381b884929c4
child 2232 9abd038ee588
--- a/src/node/socket-factory.h	Tue Dec 11 10:25:34 2007 +0100
+++ b/src/node/socket-factory.h	Tue Dec 11 23:02:47 2007 -0800
@@ -28,6 +28,22 @@
 
 class Socket;
 
+/**
+ * \brief Object to create transport layer instances that provide a 
+ * socket API to applications.
+ *
+ * This base class defines the API for creating sockets.  
+ * The socket factory also can hold the global variables used to
+ * initialize newly created sockets, such as values that are
+ * set through the sysctl or proc interfaces in Linux.
+
+ * If you want to write a new transport protocol accessible through
+ * sockets, you need to subclass this factory class, implement CreateSocket, 
+ * instantiate the object, and aggregate it to the node.  
+ * 
+ * \see Udp
+ * \see UdpImpl
+ */
 class SocketFactory : public Object
 {
 public:
@@ -35,6 +51,11 @@
 
   SocketFactory ();
 
+  /**
+   * \return smart pointer to Socket
+   * 
+   * Base class method for creating socket instances.
+   */
   virtual Ptr<Socket> CreateSocket (void) = 0;
 };