00001 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ 00002 /* 00003 * Copyright (c) 2007 INRIA 00004 * 00005 * This program is free software; you can redistribute it and/or modify 00006 * it under the terms of the GNU General Public License version 2 as 00007 * published by the Free Software Foundation; 00008 * 00009 * This program is distributed in the hope that it will be useful, 00010 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00012 * GNU General Public License for more details. 00013 * 00014 * You should have received a copy of the GNU General Public License 00015 * along with this program; if not, write to the Free Software 00016 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 00017 * 00018 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr> 00019 */ 00020 #ifndef SOCKET_FACTORY_H 00021 #define SOCKET_FACTORY_H 00022 00023 #include "ns3/object.h" 00024 #include "ns3/ptr.h" 00025 00026 namespace ns3 { 00027 00028 class Socket; 00029 00030 /** 00031 * \ingroup socket 00032 * 00033 * \brief Object to create transport layer instances that provide a 00034 * socket API to applications. 00035 * 00036 * This base class defines the API for creating sockets. 00037 * The socket factory also can hold the global variables used to 00038 * initialize newly created sockets, such as values that are 00039 * set through the sysctl or proc interfaces in Linux. 00040 00041 * If you want to write a new transport protocol accessible through 00042 * sockets, you need to subclass this factory class, implement CreateSocket, 00043 * instantiate the object, and aggregate it to the node. 00044 * 00045 * \see Udp 00046 * \see UdpImpl 00047 */ 00048 class SocketFactory : public Object 00049 { 00050 public: 00051 static TypeId GetTypeId (void); 00052 00053 SocketFactory (); 00054 00055 /** 00056 * \return smart pointer to Socket 00057 * 00058 * Base class method for creating socket instances. 00059 */ 00060 virtual Ptr<Socket> CreateSocket (void) = 0; 00061 }; 00062 00063 } // namespace ns3 00064 00065 00066 #endif /* SOCKET_FACTORY_H */