udp_socket.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
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 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 
30 #pragma once
31 
32 #include "../api_network.h"
33 #include <memory>
34 
35 namespace clan
36 {
39 
40 class Event;
41 class SocketName;
42 class UDPSocket_Impl;
43 
45 class CL_API_NETWORK UDPSocket
46 {
49 
50 public:
51  UDPSocket();
52 
57  UDPSocket(const SocketName &local_name, bool force_bind = true);
58 
63  UDPSocket(int socket, bool close_socket);
64 
65  ~UDPSocket();
66 
70 
71 public:
72 
76  int get_handle() const;
77 
81  SocketName get_local_name() const;
82 
86  Event get_read_event();
87 
91  Event get_write_event();
92 
96 
97 public:
98 
103  void bind(const SocketName &local_name, bool force_bind = true);
104 
109  void set_handle(int socket, bool close_socket);
110 
118  int send(const void *data, int len, const SocketName &to);
119 
127  int receive(void *data, int len, SocketName &out_from);
128 
136  int peek(void *data, int len, SocketName &out_from);
137 
141 
142 private:
143  std::shared_ptr<UDPSocket_Impl> impl;
145 };
146 
147 }
148 
UDP socket.
Definition: udp_socket.h:45
Socket name; container class for an IP address and port.
Definition: socket_name.h:45
OS level event.
Definition: Core/System/event.h:48