Spinning Topp Logo BlackTopp Studios
inc
ipv4socket.h
1 // © Copyright 2010 - 2014 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine 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 The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 
41 #ifndef _networkipv4socket_h
42 #define _networkipv4socket_h
43 
44 #include "Network/socket.h"
45 
46 namespace Mezzanine
47 {
48  namespace Network
49  {
50  ///////////////////////////////////////////////////////////////////////////////
51  /// @brief A socket class using the IP version 4 protocol.
52  ///////////////////////////////////////
53  class MEZZ_LIB IPv4Socket : virtual public Socket
54  {
55  protected:
56  public:
57  /// @brief Class constructor.
58  IPv4Socket();
59  /// @brief Class destructor.
60  virtual ~IPv4Socket();
61 
62  ///////////////////////////////////////////////////////////////////////////////
63  // Utility
64 
65  /// @copydoc Socket::GetNetworkLayerProtocol() const
66  virtual NetworkLayerProtocol GetNetworkLayerProtocol() const;
67 
68  ///////////////////////////////////////////////////////////////////////////////
69  // Configuration
70 
71  /// @copydoc Socket::SetNumUnicastHops(const Integer)
72  void SetNumUnicastHops(const Integer Hops);
73  /// @copydoc Socket::GetNumUnicastHops() const
74  Integer GetNumUnicastHops() const;
75  };//IPv4Socket
76  }//Network
77 }//Mezzanine
78 
79 #endif
This is a basic socket interface for the transmission and retrieval of packets.
Definition: socket.h:152
NetworkLayerProtocol
This is an enum listing for recognized protocols on Layer 3 of the OSI model.
int Integer
A datatype used to represent any integer close to.
Definition: datatypes.h:154
A socket class using the IP version 4 protocol.
Definition: ipv4socket.h:53
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56