net/socket/unix_domain_client_socket_posix.h

   1 // Copyright 2014 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_SOCKET_UNIX_DOMAIN_CLIENT_SOCKET_POSIX_H_
   6 #define NET_SOCKET_UNIX_DOMAIN_CLIENT_SOCKET_POSIX_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/macros.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "net/base/completion_callback.h"
  14 #include "net/base/net_export.h"
  15 #include "net/base/net_log.h"
  16 #include "net/socket/socket_descriptor.h"
  17 #include "net/socket/stream_socket.h"
  18
  19 namespace net {
  20
  21 class SocketLibevent;
  22 struct SockaddrStorage;
  23
  24 // A client socket that uses unix domain socket as the transport layer.
  25 class NET_EXPORT UnixDomainClientSocket : public StreamSocket {
  26  public:
  27   // Builds a client socket with |socket_path|. The caller should call Connect()
  28   // to connect to a server socket.
  29   UnixDomainClientSocket(const std::string& socket_path,
  30                          bool use_abstract_namespace);
  31   // Builds a client socket with socket libevent which is already connected.
  32   // UnixDomainServerSocket uses this after it accepts a connection.
  33   explicit UnixDomainClientSocket(scoped_ptr<SocketLibevent> socket);
  34
  35   ~UnixDomainClientSocket() override;
  36
  37   // Fills |address| with |socket_path| and its length. For Android or Linux
  38   // platform, this supports abstract namespaces.
  39   static bool FillAddress(const std::string& socket_path,
  40                           bool use_abstract_namespace,
  41                           SockaddrStorage* address);
  42
  43   // StreamSocket implementation.
  44   int Connect(const CompletionCallback& callback) override;
  45   void Disconnect() override;
  46   bool IsConnected() const override;
  47   bool IsConnectedAndIdle() const override;
  48   int GetPeerAddress(IPEndPoint* address) const override;
  49   int GetLocalAddress(IPEndPoint* address) const override;
  50   const BoundNetLog& NetLog() const override;
  51   void SetSubresourceSpeculation() override;
  52   void SetOmniboxSpeculation() override;
  53   bool WasEverUsed() const override;
  54   bool UsingTCPFastOpen() const override;
  55   bool WasNpnNegotiated() const override;
  56   NextProto GetNegotiatedProtocol() const override;
  57   bool GetSSLInfo(SSLInfo* ssl_info) override;
  58
  59   // Socket implementation.
  60   int Read(IOBuffer* buf,
  61            int buf_len,
  62            const CompletionCallback& callback) override;
  63   int Write(IOBuffer* buf,
  64             int buf_len,
  65             const CompletionCallback& callback) override;
  66   int SetReceiveBufferSize(int32 size) override;
  67   int SetSendBufferSize(int32 size) override;
  68
  69   // Releases ownership of underlying SocketDescriptor to caller.
  70   // Internal state is reset so that this object can be used again.
  71   // Socket must be connected in order to release it.
  72   SocketDescriptor ReleaseConnectedSocket();
  73
  74  private:
  75   const std::string socket_path_;
  76   const bool use_abstract_namespace_;
  77   scoped_ptr<SocketLibevent> socket_;
  78   // This net log is just to comply StreamSocket::NetLog(). It throws away
  79   // everything.
  80   BoundNetLog net_log_;
  81
  82   DISALLOW_COPY_AND_ASSIGN(UnixDomainClientSocket);
  83 };
  84
  85 }  // namespace net
  86
  87 #endif  // NET_SOCKET_UNIX_DOMAIN_CLIENT_SOCKET_POSIX_H_