Gamedev Framework (gf)  0.17.0
A C++14 framework for 2D games
UdpSocket.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2019 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  */
21 #ifndef GF_UDP_SOCKET_H
22 #define GF_UDP_SOCKET_H
23 
24 #include <cstdint>
25 #include <string>
26 
27 #include "ArrayRef.h"
28 #include "BufferRef.h"
29 #include "Portability.h"
30 #include "Socket.h"
31 #include "SocketAddress.h"
32 #include "Types.h"
33 
34 namespace gf {
35 #ifndef DOXYGEN_SHOULD_SKIP_THIS
36 inline namespace v1 {
37 #endif
38 
52  class GF_API UdpSocket : public Socket {
53  public:
59  UdpSocket() = default;
60 
71 
81  UdpSocket(const std::string& service, SocketFamily family = SocketFamily::Unspec);
82 
92  SocketAddress getRemoteAddress(const std::string& hostname, const std::string& service);
93 
101  SocketDataResult sendRawBytesTo(ArrayRef<uint8_t> buffer, const SocketAddress& address);
102 
110  SocketDataResult recvRawBytesFrom(BufferRef<uint8_t> buffer, SocketAddress& address);
111 
121  bool sendBytesTo(ArrayRef<uint8_t> buffer, const SocketAddress& address);
122 
132  bool recvBytesFrom(BufferRef<uint8_t> buffer, SocketAddress& address);
133 
134  private:
135  static SocketHandle nativeBind(const std::string& service, SocketFamily family);
136  };
137 
138 #ifndef DOXYGEN_SHOULD_SKIP_THIS
139 }
140 #endif
141 }
142 
143 #endif // GF_UDP_SOCKET_H
SocketFamily
A socket family.
Definition: SocketAddress.h:50
The result of a socket operation.
Definition: Socket.h:97
Semantic type to represent "any".
Definition: Types.h:69
Unspecified (either IPv4 or IPv6)
constexpr BufferRef< T > buffer(T *data, std::size_t size)
Create a reference to a buffer.
Definition: BufferRef.h:211
The namespace for gf classes.
Definition: Action.h:35
A UDP socket.
Definition: UdpSocket.h:52
implementation-defined SocketHandle
A native socket handle.
Definition: Socket.h:63
A network socket.
Definition: Socket.h:109
A socket address.
Definition: SocketAddress.h:78