1// Copyright (c) 2012 The Chromium Authors. All rights reserved. 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5#ifndef NET_UDP_UDP_SOCKET_WIN_H_ 6#define NET_UDP_UDP_SOCKET_WIN_H_ 7 8#include <winsock2.h> 9 10#include "base/memory/ref_counted.h" 11#include "base/memory/scoped_ptr.h" 12#include "base/threading/non_thread_safe.h" 13#include "base/win/object_watcher.h" 14#include "net/base/completion_callback.h" 15#include "net/base/net_export.h" 16#include "net/base/rand_callback.h" 17#include "net/base/ip_endpoint.h" 18#include "net/base/io_buffer.h" 19#include "net/base/net_log.h" 20#include "net/udp/datagram_socket.h" 21 22namespace net { 23 24class NET_EXPORT UDPSocketWin : NON_EXPORTED_BASE(public base::NonThreadSafe) { 25 public: 26 UDPSocketWin(DatagramSocket::BindType bind_type, 27 const RandIntCallback& rand_int_cb, 28 net::NetLog* net_log, 29 const net::NetLog::Source& source); 30 virtual ~UDPSocketWin(); 31 32 // Connect the socket to connect with a certain |address|. 33 // Returns a net error code. 34 int Connect(const IPEndPoint& address); 35 36 // Bind the address/port for this socket to |address|. This is generally 37 // only used on a server. 38 // Returns a net error code. 39 int Bind(const IPEndPoint& address); 40 41 // Close the socket. 42 void Close(); 43 44 // Copy the remote udp address into |address| and return a network error code. 45 int GetPeerAddress(IPEndPoint* address) const; 46 47 // Copy the local udp address into |address| and return a network error code. 48 // (similar to getsockname) 49 int GetLocalAddress(IPEndPoint* address) const; 50 51 // IO: 52 // Multiple outstanding read requests are not supported. 53 // Full duplex mode (reading and writing at the same time) is supported 54 55 // Read from the socket. 56 // Only usable from the client-side of a UDP socket, after the socket 57 // has been connected. 58 int Read(IOBuffer* buf, int buf_len, const CompletionCallback& callback); 59 60 // Write to the socket. 61 // Only usable from the client-side of a UDP socket, after the socket 62 // has been connected. 63 int Write(IOBuffer* buf, int buf_len, const CompletionCallback& callback); 64 65 // Read from a socket and receive sender address information. 66 // |buf| is the buffer to read data into. 67 // |buf_len| is the maximum amount of data to read. 68 // |address| is a buffer provided by the caller for receiving the sender 69 // address information about the received data. This buffer must be kept 70 // alive by the caller until the callback is placed. 71 // |address_length| is a ptr to the length of the |address| buffer. This 72 // is an input parameter containing the maximum size |address| can hold 73 // and also an output parameter for the size of |address| upon completion. 74 // |callback| the callback on completion of the Recv. 75 // Returns a net error code, or ERR_IO_PENDING if the IO is in progress. 76 // If ERR_IO_PENDING is returned, the caller must keep |buf|, |address|, 77 // and |address_length| alive until the callback is called. 78 int RecvFrom(IOBuffer* buf, 79 int buf_len, 80 IPEndPoint* address, 81 const CompletionCallback& callback); 82 83 // Send to a socket with a particular destination. 84 // |buf| is the buffer to send 85 // |buf_len| is the number of bytes to send 86 // |address| is the recipient address. 87 // |address_length| is the size of the recipient address 88 // |callback| is the user callback function to call on complete. 89 // Returns a net error code, or ERR_IO_PENDING if the IO is in progress. 90 // If ERR_IO_PENDING is returned, the caller must keep |buf| and |address| 91 // alive until the callback is called. 92 int SendTo(IOBuffer* buf, 93 int buf_len, 94 const IPEndPoint& address, 95 const CompletionCallback& callback); 96 97 // Set the receive buffer size (in bytes) for the socket. 98 bool SetReceiveBufferSize(int32 size); 99 100 // Set the send buffer size (in bytes) for the socket. 101 bool SetSendBufferSize(int32 size); 102 103 // Returns true if the socket is already connected or bound. 104 bool is_connected() const { return socket_ != INVALID_SOCKET; } 105 106 const BoundNetLog& NetLog() const { return net_log_; } 107 108 // Sets corresponding flags in |socket_options_| to allow the socket 109 // to share the local address to which the socket will be bound with 110 // other processes. Should be called before Bind(). 111 void AllowAddressReuse(); 112 113 // Sets corresponding flags in |socket_options_| to allow sending 114 // and receiving packets to and from broadcast addresses. Should be 115 // called before Bind(). 116 void AllowBroadcast(); 117 118 // Join the multicast group. 119 // |group_address| is the group address to join, could be either 120 // an IPv4 or IPv6 address. 121 // Return a network error code. 122 int JoinGroup(const IPAddressNumber& group_address) const; 123 124 // Leave the multicast group. 125 // |group_address| is the group address to leave, could be either 126 // an IPv4 or IPv6 address. If the socket hasn't joined the group, 127 // it will be ignored. 128 // It's optional to leave the multicast group before destroying 129 // the socket. It will be done by the OS. 130 // Return a network error code. 131 int LeaveGroup(const IPAddressNumber& group_address) const; 132 133 // Set interface to use for multicast. If |interface_index| set to 0, default 134 // interface is used. 135 // Should be called before Bind(). 136 // Returns a network error code. 137 int SetMulticastInterface(uint32 interface_index); 138 139 // Set the time-to-live option for UDP packets sent to the multicast 140 // group address. The default value of this option is 1. 141 // Cannot be negative or more than 255. 142 // Should be called before Bind(). 143 int SetMulticastTimeToLive(int time_to_live); 144 145 // Set the loopback flag for UDP socket. If this flag is true, the host 146 // will receive packets sent to the joined group from itself. 147 // The default value of this option is true. 148 // Should be called before Bind(). 149 // 150 // Note: the behavior of |SetMulticastLoopbackMode| is slightly 151 // different between Windows and Unix-like systems. The inconsistency only 152 // happens when there are more than one applications on the same host 153 // joined to the same multicast group while having different settings on 154 // multicast loopback mode. On Windows, the applications with loopback off 155 // will not RECEIVE the loopback packets; while on Unix-like systems, the 156 // applications with loopback off will not SEND the loopback packets to 157 // other applications on the same host. See MSDN: http://goo.gl/6vqbj 158 int SetMulticastLoopbackMode(bool loopback); 159 160 // Set the differentiated services flags on outgoing packets. May not 161 // do anything on some platforms. 162 int SetDiffServCodePoint(DiffServCodePoint dscp); 163 164 private: 165 enum SocketOptions { 166 SOCKET_OPTION_REUSE_ADDRESS = 1 << 0, 167 SOCKET_OPTION_BROADCAST = 1 << 1, 168 SOCKET_OPTION_MULTICAST_LOOP = 1 << 2 169 }; 170 171 class Core; 172 173 void DoReadCallback(int rv); 174 void DoWriteCallback(int rv); 175 void DidCompleteRead(); 176 void DidCompleteWrite(); 177 178 // Handles stats and logging. |result| is the number of bytes transferred, on 179 // success, or the net error code on failure. LogRead retrieves the address 180 // from |recv_addr_storage_|, while LogWrite takes it as an optional argument. 181 void LogRead(int result, const char* bytes) const; 182 void LogWrite(int result, const char* bytes, const IPEndPoint* address) const; 183 184 // Returns the OS error code (or 0 on success). 185 int CreateSocket(int addr_family); 186 187 // Same as SendTo(), except that address is passed by pointer 188 // instead of by reference. It is called from Write() with |address| 189 // set to NULL. 190 int SendToOrWrite(IOBuffer* buf, 191 int buf_len, 192 const IPEndPoint* address, 193 const CompletionCallback& callback); 194 195 int InternalConnect(const IPEndPoint& address); 196 int InternalRecvFrom(IOBuffer* buf, int buf_len, IPEndPoint* address); 197 int InternalSendTo(IOBuffer* buf, int buf_len, const IPEndPoint* address); 198 199 // Applies |socket_options_| to |socket_|. Should be called before 200 // Bind(). 201 int SetSocketOptions(); 202 int DoBind(const IPEndPoint& address); 203 // Binds to a random port on |address|. 204 int RandomBind(const IPAddressNumber& address); 205 206 // Attempts to convert the data in |recv_addr_storage_| and |recv_addr_len_| 207 // to an IPEndPoint and writes it to |address|. Returns true on success. 208 bool ReceiveAddressToIPEndpoint(IPEndPoint* address) const; 209 210 SOCKET socket_; 211 int addr_family_; 212 213 // Bitwise-or'd combination of SocketOptions. Specifies the set of 214 // options that should be applied to |socket_| before Bind(). 215 int socket_options_; 216 217 // Multicast interface. 218 uint32 multicast_interface_; 219 220 // Multicast socket options cached for SetSocketOption. 221 // Cannot be used after Bind(). 222 int multicast_time_to_live_; 223 224 // How to do source port binding, used only when UDPSocket is part of 225 // UDPClientSocket, since UDPServerSocket provides Bind. 226 DatagramSocket::BindType bind_type_; 227 228 // PRNG function for generating port numbers. 229 RandIntCallback rand_int_cb_; 230 231 // These are mutable since they're just cached copies to make 232 // GetPeerAddress/GetLocalAddress smarter. 233 mutable scoped_ptr<IPEndPoint> local_address_; 234 mutable scoped_ptr<IPEndPoint> remote_address_; 235 236 // The core of the socket that can live longer than the socket itself. We pass 237 // resources to the Windows async IO functions and we have to make sure that 238 // they are not destroyed while the OS still references them. 239 scoped_refptr<Core> core_; 240 241 IPEndPoint* recv_from_address_; 242 243 // Cached copy of the current address we're sending to, if any. Used for 244 // logging. 245 scoped_ptr<IPEndPoint> send_to_address_; 246 247 // External callback; called when read is complete. 248 CompletionCallback read_callback_; 249 250 // External callback; called when write is complete. 251 CompletionCallback write_callback_; 252 253 BoundNetLog net_log_; 254 255 DISALLOW_COPY_AND_ASSIGN(UDPSocketWin); 256}; 257 258} // namespace net 259 260#endif // NET_UDP_UDP_SOCKET_WIN_H_ 261