Remove timing limitation to set Broadcast, ReceiveBuffer, and SendBuffer options from UDPSocket.

net/udp/udp_socket_libevent.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef NET_UDP_UDP_SOCKET_LIBEVENT_H_
 #define NET_UDP_UDP_SOCKET_LIBEVENT_H_
 
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop/message_loop.h"
 #include "base/threading/non_thread_safe.h"
+#include "net/base/address_family.h"
 #include "net/base/completion_callback.h"
 #include "net/base/io_buffer.h"
 #include "net/base/ip_endpoint.h"
 #include "net/base/net_export.h"
 #include "net/base/net_log.h"
 #include "net/base/rand_callback.h"
 #include "net/socket/socket_descriptor.h"
 #include "net/udp/datagram_socket.h"
 
 namespace net {
 
 class NET_EXPORT UDPSocketLibevent : public base::NonThreadSafe {
  public:
   UDPSocketLibevent(DatagramSocket::BindType bind_type,
                     const RandIntCallback& rand_int_cb,
                     net::NetLog* net_log,
                     const net::NetLog::Source& source);
   virtual ~UDPSocketLibevent();
 
+  // Opens the socket.
+  // Returns a net error code.
+  int Open(AddressFamily address_family);
+
   // Connect the socket to connect with a certain |address|.
+  // Should be called after Open().
   // Returns a net error code.
   int Connect(const IPEndPoint& address);
 
   // Bind the address/port for this socket to |address|.  This is generally
-  // only used on a server.
+  // only used on a server. Should be called after Open().
   // Returns a net error code.
   int Bind(const IPEndPoint& address);
 
   // Close the socket.
   void Close();
 
-  // Copy the remote udp address into |address| and return a network error code.
+  // Copy the remote udp address into |address| and return a net error code.
   int GetPeerAddress(IPEndPoint* address) const;
 
-  // Copy the local udp address into |address| and return a network error code.
+  // Copy the local udp address into |address| and return a net error code.
   // (similar to getsockname)
   int GetLocalAddress(IPEndPoint* address) const;
 
   // IO:
   // Multiple outstanding read requests are not supported.
   // Full duplex mode (reading and writing at the same time) is supported
 
   // Read from the socket.
   // Only usable from the client-side of a UDP socket, after the socket
   // has been connected.
@@ skipping 30 matching lines @@
   // |callback| is the user callback function to call on complete.
   // Returns a net error code, or ERR_IO_PENDING if the IO is in progress.
   // If ERR_IO_PENDING is returned, the caller must keep |buf| and |address|
   // alive until the callback is called.
   int SendTo(IOBuffer* buf,
              int buf_len,
              const IPEndPoint& address,
              const CompletionCallback& callback);
 
   // Set the receive buffer size (in bytes) for the socket.
+  // Returns a net error code.
   int SetReceiveBufferSize(int32 size);
 
   // Set the send buffer size (in bytes) for the socket.
+  // Returns a net error code.
   int SetSendBufferSize(int32 size);
 
   // Returns true if the socket is already connected or bound.
-  bool is_connected() const { return socket_ != kInvalidSocket; }
+  bool is_connected() const { return is_connected_; }
 
   const BoundNetLog& NetLog() const { return net_log_; }
 
   // Sets corresponding flags in |socket_options_| to allow the socket
   // to share the local address to which the socket will be bound with
   // other processes. Should be called before Bind().

[rvargas (doing something else), 2014/12/03 21:00:16]

nit: returns a ...

[hidehiko, 2014/12/04 04:03:36]

Done. Walked though the udp_socket_libevent.h and upd_socket_win.h, and
standardized to third-person-singular-person form for all function comments.

[rvargas (doing something else), 2014/12/04 19:51:37]

I'm sorry I was not clear with this one. Now there is a return value so we have
to document what it is.

[hidehiko, 2014/12/08 05:07:40]

Oops, I misunderstood your comments. Fixed the comments.

-  void AllowAddressReuse();
+  int AllowAddressReuse();
 
-  // Sets corresponding flags in |socket_options_| to allow sending
-  // and receiving packets to and from broadcast addresses. Should be
-  // called before Bind().
-  void AllowBroadcast();
+  // Sets corresponding flags in |socket_options_| to allow or disallow sending
+  // and receiving packets to and from broadcast addresses.
+  // Returns a net error code.
+  int SetBroadcast(bool broadcast);
 
   // Join the multicast group.
   // |group_address| is the group address to join, could be either
   // an IPv4 or IPv6 address.
-  // Return a network error code.
+  // Return a net error code.

[rvargas (doing something else), 2014/12/03 21:00:16]

nit: return -> returns

[hidehiko, 2014/12/04 04:03:36]

Done.

   int JoinGroup(const IPAddressNumber& group_address) const;
 
   // Leave the multicast group.
   // |group_address| is the group address to leave, could be either
   // an IPv4 or IPv6 address. If the socket hasn't joined the group,
   // it will be ignored.
   // It's optional to leave the multicast group before destroying
   // the socket. It will be done by the OS.
-  // Return a network error code.
+  // Return a net error code.

[rvargas (doing something else), 2014/12/03 21:00:16]

etc

[hidehiko, 2014/12/04 04:03:36]

Done.

   int LeaveGroup(const IPAddressNumber& group_address) const;
 
   // Set interface to use for multicast. If |interface_index| set to 0, default
   // interface is used.
   // Should be called before Bind().
-  // Returns a network error code.
+  // Returns a net error code.
   int SetMulticastInterface(uint32 interface_index);
 
   // Set the time-to-live option for UDP packets sent to the multicast
   // group address. The default value of this option is 1.
   // Cannot be negative or more than 255.
   // Should be called before Bind().
-  // Return a network error code.
+  // Return a net error code.
   int SetMulticastTimeToLive(int time_to_live);
 
   // Set the loopback flag for UDP socket. If this flag is true, the host
   // will receive packets sent to the joined group from itself.
   // The default value of this option is true.
   // Should be called before Bind().
-  // Return a network error code.
+  // Return a net error code.
   //
   // Note: the behavior of |SetMulticastLoopbackMode| is slightly
   // different between Windows and Unix-like systems. The inconsistency only
   // happens when there are more than one applications on the same host
   // joined to the same multicast group while having different settings on
   // multicast loopback mode. On Windows, the applications with loopback off
   // will not RECEIVE the loopback packets; while on Unix-like systems, the
   // applications with loopback off will not SEND the loopback packets to
   // other applications on the same host. See MSDN: http://goo.gl/6vqbj
   int SetMulticastLoopbackMode(bool loopback);
 
   // Set the differentiated services flags on outgoing packets. May not
   // do anything on some platforms.
-  // Return a network error code.
+  // Return a net error code.
   int SetDiffServCodePoint(DiffServCodePoint dscp);
 
   // Resets the thread to be used for thread-safety checks.
   void DetachFromThread();
 
  private:
   enum SocketOptions {
     SOCKET_OPTION_REUSE_ADDRESS  = 1 << 0,

[rvargas (doing something else), 2014/12/03 21:00:16]

should not need this

[hidehiko, 2014/12/04 04:03:36]

Oops, overlooked. Removed.

-    SOCKET_OPTION_BROADCAST      = 1 << 1,
-    SOCKET_OPTION_MULTICAST_LOOP = 1 << 2
+    SOCKET_OPTION_MULTICAST_LOOP = 1 << 1
   };
 
   class ReadWatcher : public base::MessageLoopForIO::Watcher {
    public:
     explicit ReadWatcher(UDPSocketLibevent* socket) : socket_(socket) {}
 
     // MessageLoopForIO::Watcher methods
 
     void OnFileCanReadWithoutBlocking(int /* fd */) override;
 
@@ skipping 27 matching lines @@
   void DidCompleteWrite();
 
   // Handles stats and logging. |result| is the number of bytes transferred, on
   // success, or the net error code on failure. On success, LogRead takes in a
   // sockaddr and its length, which are mandatory, while LogWrite takes in an
   // optional IPEndPoint.
   void LogRead(int result, const char* bytes, socklen_t addr_len,
                const sockaddr* addr) const;
   void LogWrite(int result, const char* bytes, const IPEndPoint* address) const;
 
-  // Returns the OS error code (or 0 on success).
-  int CreateSocket(int addr_family);
-
   // Same as SendTo(), except that address is passed by pointer
   // instead of by reference. It is called from Write() with |address|
   // set to NULL.
   int SendToOrWrite(IOBuffer* buf,
                     int buf_len,
                     const IPEndPoint* address,
                     const CompletionCallback& callback);
 
   int InternalConnect(const IPEndPoint& address);
   int InternalRecvFrom(IOBuffer* buf, int buf_len, IPEndPoint* address);
   int InternalSendTo(IOBuffer* buf, int buf_len, const IPEndPoint* address);
 
   // Applies |socket_options_| to |socket_|. Should be called before
   // Bind().
-  int SetSocketOptions();
+  int SetMulticastOptions();
   int DoBind(const IPEndPoint& address);
   // Binds to a random port on |address|.
   int RandomBind(const IPAddressNumber& address);
 
   int socket_;
   int addr_family_;
+  bool is_connected_;
 
   // Bitwise-or'd combination of SocketOptions. Specifies the set of
   // options that should be applied to |socket_| before Bind().
   int socket_options_;
 
   // Multicast interface.
   uint32 multicast_interface_;
 
-  // Multicast socket options cached for SetSocketOption.
+  // Multicast socket options cached for SetMulticastOption.
   // Cannot be used after Bind().
   int multicast_time_to_live_;
 
   // How to do source port binding, used only when UDPSocket is part of
   // UDPClientSocket, since UDPServerSocket provides Bind.
   DatagramSocket::BindType bind_type_;
 
   // PRNG function for generating port numbers.
   RandIntCallback rand_int_cb_;
 
@@ skipping 27 matching lines @@
   CompletionCallback write_callback_;
 
   BoundNetLog net_log_;
 
   DISALLOW_COPY_AND_ASSIGN(UDPSocketLibevent);
 };
 
 }  // namespace net
 
 #endif  // NET_UDP_UDP_SOCKET_LIBEVENT_H_