1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007 Georgia Tech Research Corporation
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  *
18  * Author: Raj Bhattacharjea <raj.b@gatech.edu>
19  */
20 #ifndef TCP_SOCKET_FACTORY_H
21 #define TCP_SOCKET_FACTORY_H
22 
23 #include "ns3/socket-factory.h"
24 
25 namespace ns3 {
26 
27 class Socket;
28 
29 /**
30  * \ingroup socket
31  * \ingroup tcp
32  *
33  * \brief API to create TCP socket instances
34  *
35  * This abstract class defines the API for TCP sockets.
36  * This class also holds the global default variables used to
37  * initialize newly created sockets, such as values that are
38  * set through the sysctl or proc interfaces in Linux.
39 
40  * All TCP socket factory implementations must provide an implementation
41  * of CreateSocket
42  * below, and should make use of the default values configured below.
43  *
44  * \see TcpSocketFactoryImpl
45  *
46  */
47 class TcpSocketFactory : public SocketFactory
48 {
49 public:
50   /**
51    * Get the type ID.
52    * \brief Get the type ID.
53    * \return the object TypeId
54    */
55   static TypeId GetTypeId (void);
56 
57 };
58 
59 } // namespace ns3
60 
61 #endif /* TCP_SOCKET_FACTORY_H */
62