xtd 0.2.0
socket.h
Go to the documentation of this file.
1 #pragma once
5 
6 #include <memory>
7 #include "../../core_export.h"
8 #include "../../argument_exception.h"
9 #include "../../async_callback.h"
10 #include "../../iasync_result.h"
11 #include "../../iequatable.h"
12 #include "../../not_implemented_exception.h"
13 #include "../../not_supported_exception.h"
14 #include "../../object.h"
15 #include "../../types.h"
16 #include "../../ustring.h"
17 #include "../end_point.h"
18 #include "../ip_address.h"
19 #include "address_family.h"
20 #include "io_control_code.h"
21 #include "ip_packet_information.h"
22 #include "ip_protection_level.h"
23 #include "linger_option.h"
24 #include "multicast_option.h"
25 #include "ip_v6_multicast_option.h"
26 #include "protocol_type.h"
27 #include "select_mode.h"
28 #include "socket_error.h"
29 #include "socket_flags.h"
30 #include "socket_information.h"
31 #include "socket_option_level.h"
32 #include "socket_option_name.h"
33 #include "socket_shutdown.h"
34 #include "socket_type.h"
35 
37 namespace xtd {
39  namespace net {
41  namespace sockets {
43  class socket_async_event_args;
45 
69  class core_export_ socket : public xtd::object, public xtd::iequatable<socket> {
71  class async_result_socket : public xtd::object, public xtd::iasync_result {
72  public:
73  explicit async_result_socket(std::any async_state) : async_state_(async_state) {}
74  std::any async_state() const noexcept override {return async_state_;}
75  std::shared_mutex& async_mutex() override {return async_mutex_;}
76  bool completed_synchronously() const noexcept override {return false;}
77  bool is_completed() const noexcept override {return is_completed_;};
78 
79  std::any async_state_;
80  bool is_completed_ = false;
81  std::shared_mutex async_mutex_;
83  std::exception_ptr exception_;
84  };
85 
87  class async_result_accept : public async_result_socket {
88  public:
89  explicit async_result_accept(std::any async_state) : async_result_socket(async_state) {}
90  std::any socket_;
91  };
92 
94  class async_result_connect : public async_result_socket {
95  public:
96  explicit async_result_connect(std::any async_state) : async_result_socket(async_state) {}
97  };
98 
100  class async_result_disconnect : public async_result_socket {
101  public:
102  explicit async_result_disconnect(std::any async_state) : async_result_socket(async_state) {}
103  };
104 
106  class async_result_receive : public async_result_socket {
107  public:
108  explicit async_result_receive(std::any async_state) : async_result_socket(async_state) {}
109  size_t number_of_bytes_received_ = 0;
110  };
111 
113  class async_result_receive_from : public async_result_socket {
114  public:
115  explicit async_result_receive_from(std::any async_state) : async_result_socket(async_state) {}
116  std::shared_ptr<xtd::net::end_point> end_point_;
117  size_t number_of_bytes_received_ = 0;
118  };
119 
121  class async_result_receive_message_from : public async_result_socket {
122  public:
123  explicit async_result_receive_message_from(std::any async_state) : async_result_socket(async_state) {}
124  std::shared_ptr<xtd::net::end_point> end_point_;
126  size_t number_of_bytes_received_ = 0;
127  xtd::net::sockets::ip_packet_information ip_packet_information_;
128  };
129 
131  class async_result_send : public async_result_socket {
132  public:
133  explicit async_result_send(std::any async_state) : async_result_socket(async_state) {}
134  size_t number_of_bytes_sent_ = 0;
135  };
136 
138  class async_result_send_to : public async_result_socket {
139  public:
140  explicit async_result_send_to(std::any async_state) : async_result_socket(async_state) {}
141  size_t number_of_bytes_sent_ = 0;
142  };
143 
144  struct data;
145 
146  public:
148 
151  socket();
152 
157  explicit socket(intptr handle);
178 
180  socket(socket&&) = default;
181  socket(const socket&) = default;
182  ~socket();
183  socket& operator =(const socket&) = default;
185 
187 
193 
198  size_t available() const;
199 
207  bool blocking() const;
216  socket& blocking(bool value);
217 
223  bool connected() const noexcept;
224 
231  bool dont_fragment() const;
239  socket& dont_fragment(bool value);
240 
247  bool dual_mode() const;
255  socket& dual_mode(bool value);
256 
264  bool enable_broadcast() const;
273  socket& enable_broadcast(bool value);
274 
283  bool exclusive_address_use() const;
294  socket& exclusive_address_use(bool value);
295 
298  intptr handle() const noexcept;
299 
303  bool is_bound() const noexcept;
304 
322  xtd::net::sockets::linger_option linger_state() const;
341  socket& linger_state(const xtd::net::sockets::linger_option& value);
342 
348  std::shared_ptr<xtd::net::end_point> local_end_point() const;
349 
358  bool multicast_loopback() const;
368  socket& multicast_loopback(bool value);
369 
378  bool no_delay() const;
388  socket& no_delay(bool value);
389 
393  static bool os_supports_ip_v4() noexcept;
394 
398  static bool os_supports_ip_v6() noexcept;
399 
404 
411  size_t receive_buffer_size() const;
419  socket& receive_buffer_size(size_t value);
420 
427  int32 receive_timeout() const;
436  socket& receive_timeout(int32 value);
437 
443  std::shared_ptr<xtd::net::end_point> remote_end_point() const;
444 
451  size_t send_buffer_size() const;
459  socket& send_buffer_size(size_t value);
460 
467  int32 send_timeout() const;
476  socket& send_timeout(int32 value);
477 
482 
492  xtd::byte ttl() const;
503  socket& ttl(xtd::byte value);
505 
507 
519  socket accept();
520 
538  bool accept_async(xtd::net::sockets::socket_async_event_args& e);
539 
554  std::shared_ptr<xtd::iasync_result> begin_accept(xtd::async_callback callback, const std::any& state);
555 
571  template<typename end_point_t>
572  std::shared_ptr<xtd::iasync_result> begin_connect(const end_point_t& remote_end_point, xtd::async_callback callback, const std::any& state) {
573  return begin_connect_(std::make_shared<end_point_t>(remote_end_point), callback, state);
574  }
588  std::shared_ptr<xtd::iasync_result> begin_connect(const xtd::net::ip_address& address, uint16 port, xtd::async_callback callback, const std::any& state);
602  std::shared_ptr<xtd::iasync_result> begin_connect(const std::vector<xtd::net::ip_address>& addresses, uint16 port, xtd::async_callback callback, const std::any& state);
616  std::shared_ptr<xtd::iasync_result> begin_connect(const xtd::ustring& host, uint16 port, xtd::async_callback callback, const std::any& state);
617 
628  std::shared_ptr<xtd::iasync_result> begin_disconnect(bool reuse_socket, xtd::async_callback callback, const std::any& state);
629 
647  std::shared_ptr<xtd::iasync_result> begin_receive(std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, xtd::async_callback callback, const std::any& state);
666  std::shared_ptr<xtd::iasync_result> begin_receive(std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, xtd::net::sockets::socket_error& error_code, xtd::async_callback callback, const std::any& state);
667 
690  std::shared_ptr<xtd::iasync_result> begin_receive_from(std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, xtd::net::end_point& remote_end_point, xtd::async_callback callback, const std::any& state);
691 
709  std::shared_ptr<xtd::iasync_result> begin_receive_message_from(std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, xtd::net::end_point& remote_end_point, xtd::async_callback callback, const std::any& state);
710 
731  std::shared_ptr<xtd::iasync_result> begin_send(const std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, xtd::async_callback callback, const std::any& state);
753  std::shared_ptr<xtd::iasync_result> begin_send(const std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, xtd::net::sockets::socket_error& error_code, xtd::async_callback callback, const std::any& state);
754 
775  std::shared_ptr<xtd::iasync_result> begin_send_to(const std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, const xtd::net::end_point& remote_end_point, xtd::async_callback callback, const std::any& state);
776 
788  template<typename end_point_t>
789  void bind(const end_point_t& local_end_point) {
790  bind_(std::make_shared<end_point_t>(local_end_point));
791  }
792 
798  void close();
799 
809  template<typename end_point_t>
810  void connect(const end_point_t& remote_end_point) {
811  connect_(std::make_shared<end_point_t>(remote_end_point));
812  }
813 
824  void connect(const xtd::net::ip_address& address, uint16 port);
825 
837  void connect(const std::vector<xtd::net::ip_address>& addresses, uint16 port);
838 
849  void connect(const xtd::ustring& host, uint16 port);
850 
859  void disconnect(bool reuse_socket);
860 
870  socket end_accept(std::shared_ptr<xtd::iasync_result> async_result);
871 
881  void end_connect(std::shared_ptr<xtd::iasync_result> async_result);
882 
890  void end_disconnect(std::shared_ptr<xtd::iasync_result> async_result);
891 
906  size_t end_receive(std::shared_ptr<xtd::iasync_result> async_result);
921  size_t end_receive(std::shared_ptr<xtd::iasync_result> async_result, xtd::net::sockets::socket_error& error_code);
922 
934  size_t end_receive_from(std::shared_ptr<xtd::iasync_result> async_result, std::shared_ptr<xtd::net::end_point>& end_point);
935 
949  size_t end_receive_message_from(std::shared_ptr<xtd::iasync_result> async_result, xtd::net::sockets::socket_flags& socket_flags, std::shared_ptr<xtd::net::end_point>& end_point, xtd::net::sockets::ip_packet_information& ip_packet_information);
950 
965  size_t end_send(std::shared_ptr<xtd::iasync_result> async_result);
981  size_t end_send(std::shared_ptr<xtd::iasync_result> async_result, xtd::net::sockets::socket_error& error_code);
982 
994  size_t end_send_to(std::shared_ptr<xtd::iasync_result> async_result);
995 
996  bool equals(const socket& s) const noexcept override;
997 
1006  size_t get_raw_socket_option(int32 socket_option_level, int32 socket_option_name, intptr option_value, size_t size_option_value) const;
1007 
1019  int32 get_socket_option(xtd::net::sockets::socket_option_level socket_option_level, xtd::net::sockets::socket_option_name socket_option_name) const;
1026  xtd::net::sockets::linger_option get_socket_linger_option() const;
1033  xtd::net::sockets::multicast_option get_socket_multicast_option(xtd::net::sockets::socket_option_name socket_option_name) const;
1040  xtd::net::sockets::ip_v6_multicast_option get_socket_ip_v6_multicast_option(xtd::net::sockets::socket_option_name socket_option_name) const;
1041 
1049  size_t io_control(int32 io_control_code, std::vector<xtd::byte>& option_in_value, std::vector<xtd::byte>& option_out_value);
1057  size_t io_control(xtd::net::sockets::io_control_code io_control_code, std::vector<xtd::byte>& option_in_value, std::vector<xtd::byte>& option_out_value);
1058 
1067  void listen(size_t backlog);
1068 
1077  void listen();
1078 
1092  bool poll(int32 micro_seconds, xtd::net::sockets::select_mode mode);
1093 
1106  size_t receive(std::vector<xtd::byte>& buffer);
1107 
1121  size_t receive(std::vector<xtd::byte>& buffer, xtd::net::sockets::socket_flags socket_flags);
1122 
1138  size_t receive(std::vector<xtd::byte>& buffer, size_t size, xtd::net::sockets::socket_flags socket_flags);
1139 
1155  size_t receive(std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags);
1156 
1172  size_t receive(std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, xtd::net::sockets::socket_error& error);
1173 
1189  size_t receive_from(std::vector<xtd::byte>& buffer, xtd::net::end_point& remote_end_point);
1190 
1207  size_t receive_from(std::vector<xtd::byte>& buffer, xtd::net::sockets::socket_flags socket_flags, xtd::net::end_point& remote_end_point);
1208 
1227  size_t receive_from(std::vector<xtd::byte>& buffer, size_t size, xtd::net::sockets::socket_flags socket_flags, xtd::net::end_point& remote_end_point);
1228 
1247  size_t receive_from(std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, xtd::net::end_point& remote_end_point);
1248 
1249  size_t receive_message_from(std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, xtd::net::end_point& remote_end_point, xtd::net::sockets::ip_packet_information& ip_packet_information);
1250 
1266  static size_t select(std::vector<socket>& check_read, std::vector<socket>& check_write, std::vector<socket>& check_error, int32 microseconds);
1267 
1280  size_t send(const std::vector<xtd::byte>& buffer);
1281 
1295  size_t send(const std::vector<xtd::byte>& buffer, xtd::net::sockets::socket_flags socket_flags);
1296 
1312  size_t send(const std::vector<xtd::byte>& buffer, size_t size, xtd::net::sockets::socket_flags socket_flags);
1313 
1330  size_t send(const std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags);
1331 
1347  size_t send(const std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, xtd::net::sockets::socket_error& error_code);
1348 
1361  size_t send_to(const std::vector<xtd::byte>& buffer, const xtd::net::end_point& remote_end_point);
1375  size_t send_to(const std::vector<xtd::byte>& buffer, xtd::net::sockets::socket_flags socket_flags, const xtd::net::end_point& remote_end_point);
1391  size_t send_to(const std::vector<xtd::byte>& buffer, size_t size, xtd::net::sockets::socket_flags socket_flags, const xtd::net::end_point& remote_end_point);
1408  size_t send_to(const std::vector<xtd::byte>& buffer, size_t offset, size_t size, xtd::net::sockets::socket_flags socket_flags, const xtd::net::end_point& remote_end_point);
1409 
1421  void set_ip_protection_level(xtd::net::sockets::ip_protection_level level);
1422 
1452  void set_socket_option(xtd::net::sockets::socket_option_level socket_option_level, xtd::net::sockets::socket_option_name socket_option_name, bool option_value);
1453 
1494  void set_socket_option(xtd::net::sockets::socket_option_level socket_option_level, xtd::net::sockets::socket_option_name socket_option_name, int32 option_value);
1500  void set_socket_option(xtd::net::sockets::linger_option option_value);
1507  void set_socket_option(xtd::net::sockets::socket_option_name socket_option_name, const xtd::net::sockets::multicast_option& option_value);
1514  void set_socket_option(xtd::net::sockets::socket_option_name socket_option_name, const xtd::net::sockets::ip_v6_multicast_option& option_value);
1515 
1526  void set_raw_socket_option(int32 socket_option_level, int32 socket_option_name, intptr option_value, size_t option_value_size);
1527 
1549 
1550  private:
1551  static xtd::net::sockets::socket_error get_last_error_();
1552  std::shared_ptr<xtd::iasync_result> begin_connect_(std::shared_ptr<xtd::net::end_point> remote_end_point, xtd::async_callback callback, const std::any& state);
1553  void bind_(std::shared_ptr<xtd::net::end_point> local_end_point);
1554  void connect_(std::shared_ptr<xtd::net::end_point> remote_end_point);
1555 
1556  std::shared_ptr<data> data_;
1557  };
1558  }
1559  }
1560 }
Implements the Berkeley sockets interface.
Definition: socket.h:69
The xtd::uri::host data.
protocol_type
Specifies the protocols that the xtd::net::sockets::socket class supports.
Definition: protocol_type.h:27
Contains xtd::net::sockets::socket_option_name enum.
ip_protection_level
A value that enables restriction of an IPv6 socket to a specified scope, such as addresses with the s...
Definition: ip_protection_level.h:28
Provides an Internet Protocol (IP) address.
Definition: ip_address.h:34
Contains xtd::net::sockets::multicast_option class.
Contains xtd::net::sockets::io_control_code enum.
intmax_t intptr
Represent a pointer or a handle.
Definition: types.h:86
Gets the error status and clear.
The SELECT key.
io_control_code
Specifies the IO control codes supported by the xtd::net::sockets::socket::io_control method...
Definition: io_control_code.h:27
Specifies whether a xtd::net::sockets::socket will remain connected after a call to the xtd::net::soc...
Definition: linger_option.h:31
Represents the status of an asynchronous operation.
Definition: iasync_result.h:21
Use no flags for this call.
Receive a time-out. This option applies only to synchronous methods; it has no effect on asynchronous...
std::shared_ptr< xtd::iasync_result > begin_connect(const end_point_t &remote_end_point, xtd::async_callback callback, const std::any &state)
Begins an asynchronous request for a remote host connection.
Definition: socket.h:572
socket_option_name
Defines configuration option names.
Definition: socket_option_name.h:28
A request to send or receive data was disallowed because the socket is closed.
Contains xtd::net::sockets::socket_flags enum.
Identifies a network address. This is an abstract class.
Definition: end_point.h:24
Contains xtd::net::sockets::ip_v6_multicast_option class.
The xtd namespace contains all fundamental classes to access Hardware, Os, System, and more.
Definition: system_report.h:17
Gets the network interface information that is associated with a call to xtd::net::sockets::socket::r...
Definition: ip_packet_information.h:33
Contains xtd::net::sockets::socket_type enum.
Contains xtd::net::sockets::select_mode enum.
Enables a socket to be bound for exclusive access.
uint_least16_t uint16
Represents a 16-bit unsigned integer.
Definition: types.h:144
delegate< void(std::shared_ptr< xtd::iasync_result > ar)> async_callback
References a method to be called when a corresponding asynchronous operation completes.
Definition: async_callback.h:18
Represents text as a sequence of UTF-8 code units.
Definition: ustring.h:48
Contains IPAddress values used to join and drop multicast groups.
Definition: multicast_option.h:36
socket_error
Defines error codes for the xtd::net::sockets::socket class.
Definition: socket_error.h:27
Send a time-out. This option applies only to synchronous methods; it has no effect on asynchronous me...
void bind(const end_point_t &local_end_point)
Associates a xtd::net::sockets::socket with a local endpoint.
Definition: socket.h:789
select_mode
Defines the polling modes for the xtd::net::sockets::socket::poll method.
Definition: select_mode.h:28
Defines a generalized method that a value type or class implements to create a type-specific method f...
Definition: iequatable.h:18
Contains xtd::net::sockets::socket_shutdown enum.
The protocol type is incorrect.
Socket options apply to all sockets.
Contains xtd::net::sockets::socket_error enum.
socket_flags
Specifies socket send and receive behaviors. This enumeration has a flags attribute that allows a bit...
Definition: socket_flags.h:27
Indicates that all styles except allow_binary_specifier, allow_octal_specifier and allow_hex_specifie...
The xtd::uri::port data.
Contains xtd::net::sockets::ip_protection_level enum.
Disables the Nagle algorithm for send coalescing.
Supports all classes in the xtd class hierarchy and provides low-level services to derived classes...
Definition: object.h:31
int_least32_t int32
Represents a 32-bit signed integer.
Definition: types.h:74
Contains xtd::net::sockets::address_family enum.
socket_shutdown
Defines constants that are used by the xtd::net::sockets::socket::shutdown method.
Definition: socket_shutdown.h:28
socket_type
Specifies the type of socket that an instance of the xtd::net::sockets::socket class represents...
Definition: socket_type.h:29
Contains option values for joining an IPv6 multicast group.
Definition: ip_v6_multicast_option.h:29
socket_option_level
Defines socket option levels for the xtd::net::sockets::socket::set_socket_option and xtd::net::socke...
Definition: socket_option_level.h:28
Contains xtd::net::sockets::linger_option class.
Contains xtd::net::sockets::socket_information class.
void connect(const end_point_t &remote_end_point)
Establishes a connection to a remote host.
Definition: socket.h:810
The socket handle may be reused when the request completes. This flag is valid only if xtd::net::sock...
uint_least8_t byte
Represents a 8-bit unsigned integer.
Definition: types.h:26
Represents an asynchronous socket operation.
Definition: socket_async_event_args.h:51
Contains xtd::net::sockets::ip_packet_information class.
Encapsulates the information that is necessary to duplicate a xtd::net::sockets::socket.
Definition: socket_information.h:30
Contains xtd::net::sockets::socket_option_level enum.
size_t size
Represents a size of any object in bytes.
Definition: types.h:120
Contains xtd::net::sockets::protocol_type enum.
address_family
Specifies the addressing scheme that an instance of the xtd::net::sockets::socket class can use...
Definition: address_family.h:27