Spinning Topp Logo BlackTopp Studios
inc
udpv4socket.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 _networkudpv4socket_h
42 #define _networkudpv4socket_h
43 
44 #include "Network/udpsocket.h"
45 #include "Network/ipv4socket.h"
46 
47 namespace Mezzanine
48 {
49  namespace Network
50  {
51  ///////////////////////////////////////////////////////////////////////////////
52  /// @brief A UDP socket that uses IPv4 internet addresses for transmissions.
53  ///////////////////////////////////////
54  class MEZZ_LIB UDPv4Socket : public IPv4Socket, public UDPSocket
55  {
56  protected:
57  public:
58  /// @brief Class constructor.
59  UDPv4Socket();
60  /// @brief Internal constructor.
61  /// @param A pointer to the internal socket to wrap.
62  UDPv4Socket(PlatformSocket* InternalSock);
63  /// @brief Binding constructor.
64  /// @param Port The port number to bind this socket to.
65  UDPv4Socket(const UInt16 Port);
66  /// @brief Class destructor.
67  virtual ~UDPv4Socket();
68 
69  ///////////////////////////////////////////////////////////////////////////////
70  // Configuration
71 
72  // Commented out due to lack of support on MacOSX. Additionally there may be better ways to moderate transmissions.
73  /*/// @brief Sets whether or not messages sent by this socket can be fragmented by routers.
74  /// @remarks In a situation where message fragmentation would occur but isn't allowed to because of this setting
75  /// the router will discard the message and send an error back to the sending host.
76  /// @param DontFrag Whether or not messages from this socket can be fragmented.
77  void SetDontFragment(const Boole DontFrag);
78  /// @brief Gets whether or not messages sent by this socket can be fragmented by routers.
79  /// @return Returns true if messages sent by this socket can be fragmented, false otherwise.
80  Boole GetDontFragment() const;// */
81 
82  /// @copydoc UDPSocket::SetNumMulticastHops(const Integer)
83  void SetNumMulticastHops(const Integer Hops);
84  /// @copydoc UDPSocket::GetNumMulticastHops() const
85  Integer GetNumMulticastHops() const;
86  /// @copydoc UDPSocket::SetMulticastLoop(const Boole)
87  void SetMulticastLoop(const Boole Loop);
88  /// @copydoc UDPSocket::GetMulticastLoop() const
89  Boole GetMulticastLoop() const;
90  };//UDPv4Socket
91  }//Network
92 }//Mezzanine
93 
94 #endif
bool Boole
Generally acts a single bit, true or false.
Definition: datatypes.h:173
A UDP socket that uses IPv4 internet addresses for transmissions.
Definition: udpv4socket.h:54
int Integer
A datatype used to represent any integer close to.
Definition: datatypes.h:154
A socket class using the User Datagram Protocol.
Definition: udpsocket.h:54
uint16_t UInt16
An 16-bit unsigned integer.
Definition: datatypes.h:122
A socket class using the IP version 4 protocol.
Definition: ipv4socket.h:53
This is helper class for managing platform specific data of socket implementations.
#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