dart::bin::SocketAddress Class Reference

#include <socket_base.h>

Public Types
enum	{ TYPE_ANY = -1 , TYPE_IPV4 , TYPE_IPV6 , TYPE_UNIX }
enum	{   ADDRESS_LOOPBACK_IP_V4 , ADDRESS_LOOPBACK_IP_V6 , ADDRESS_ANY_IP_V4 , ADDRESS_ANY_IP_V6 ,   ADDRESS_FIRST = ADDRESS_LOOPBACK_IP_V4 , ADDRESS_LAST = ADDRESS_ANY_IP_V6 }

Public Member Functions
	SocketAddress (struct sockaddr *sa, bool unnamed_unix_socket=false)
	~SocketAddress ()
int	GetType ()
const char *	as_string () const
const RawAddr &	addr () const

Static Public Member Functions
static intptr_t	GetAddrLength (const RawAddr &addr, bool unnamed_unix_socket=false)
static intptr_t	GetInAddrLength (const RawAddr &addr)
static bool	AreAddressesEqual (const RawAddr &a, const RawAddr &b)
static void	GetSockAddr (Dart_Handle obj, RawAddr *addr)
static Dart_Handle	GetUnixDomainSockAddr (const char *path, Namespace *namespc, RawAddr *addr)
static int16_t	FromType (int type)
static void	SetAddrPort (RawAddr *addr, intptr_t port)
static intptr_t	GetAddrPort (const RawAddr &addr)
static Dart_Handle	ToTypedData (const RawAddr &addr)
static CObjectUint8Array *	ToCObject (const RawAddr &addr)
static void	SetAddrScope (RawAddr *addr, intptr_t scope_id)
static intptr_t	GetAddrScope (const RawAddr &addr)

Detailed Description

Definition at line 41 of file socket_base.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
TYPE_ANY
TYPE_IPV4
TYPE_IPV6
TYPE_UNIX

Definition at line 43 of file socket_base.h.

       {
    TYPE_ANY = -1,
    TYPE_IPV4,
    TYPE_IPV6,
    TYPE_UNIX,
  };

anonymous enum

anonymous enum

Enumerator
ADDRESS_LOOPBACK_IP_V4
ADDRESS_LOOPBACK_IP_V6
ADDRESS_ANY_IP_V4
ADDRESS_ANY_IP_V6
ADDRESS_FIRST
ADDRESS_LAST

Definition at line 50 of file socket_base.h.

       {
    ADDRESS_LOOPBACK_IP_V4,
    ADDRESS_LOOPBACK_IP_V6,
    ADDRESS_ANY_IP_V4,
    ADDRESS_ANY_IP_V6,
    ADDRESS_FIRST = ADDRESS_LOOPBACK_IP_V4,
    ADDRESS_LAST = ADDRESS_ANY_IP_V6,
  };

Constructor & Destructor Documentation

SocketAddress()

dart::bin::SocketAddress::SocketAddress ( struct sockaddr *  sa, bool  unnamed_unix_socket = false  )

explicit

~SocketAddress()

dart::bin::SocketAddress::~SocketAddress ( )

inline

Definition at line 63 of file socket_base.h.

{}

Member Function Documentation

addr()

const RawAddr & dart::bin::SocketAddress::addr ( ) const

inline

Definition at line 68 of file socket_base.h.

{ return addr_; }

AreAddressesEqual()

bool dart::bin::SocketAddress::AreAddressesEqual ( const RawAddr &  a, const RawAddr &  b  )

static

Definition at line 80 of file socket_base.cc.

                                                                        {
  if (a.ss.ss_family != b.ss.ss_family) {
    return false;
  }
  if (a.ss.ss_family == AF_INET) {
    return memcmp(&a.in.sin_addr, &b.in.sin_addr, sizeof(a.in.sin_addr)) == 0;
  } else if (a.ss.ss_family == AF_INET6) {
    return memcmp(&a.in6.sin6_addr, &b.in6.sin6_addr,
                  sizeof(a.in6.sin6_addr)) == 0 &&
           a.in6.sin6_scope_id == b.in6.sin6_scope_id;
  } else if (a.ss.ss_family == AF_UNIX) {
    // This is not used anywhere. The comparison of file path is done via
    // File::AreIdentical().
    int len = sizeof(a.un.sun_path);
    for (int i = 0; i < len; i++) {
      if (a.un.sun_path[i] != b.un.sun_path[i]) return false;
      if (a.un.sun_path[i] == '\0') return true;
    }
    return true;
  } else {
    UNREACHABLE();
    return false;
  }
}

as_string()

const char * dart::bin::SocketAddress::as_string ( ) const

inline

Definition at line 67 of file socket_base.h.

{ return as_string_; }

FromType()

int16_t dart::bin::SocketAddress::FromType ( int  type )

static

Definition at line 163 of file socket_base.cc.

                                        {
  if (type == TYPE_ANY) {
    return AF_UNSPEC;
  }
  if (type == TYPE_IPV4) {
    return AF_INET;
  }
  if (type == TYPE_UNIX) {
    return AF_UNIX;
  }
  ASSERT((type == TYPE_IPV6) && "Invalid type");
  return AF_INET6;
}

GetAddrLength()

intptr_t dart::bin::SocketAddress::GetAddrLength ( const RawAddr &  addr, bool  unnamed_unix_socket = false  )

static

Definition at line 39 of file socket_base.cc.

                                                                {
  ASSERT((addr.ss.ss_family == AF_INET) || (addr.ss.ss_family == AF_INET6) ||
         (addr.ss.ss_family == AF_UNIX));
  switch (addr.ss.ss_family) {
    case AF_INET6:
      return sizeof(struct sockaddr_in6);
    case AF_INET:
      return sizeof(struct sockaddr_in);
    case AF_UNIX: {
      // For an abstract UNIX socket, trailing null bytes in the name are
      // meaningful. That is, the bytes '\0/tmp/dbus-xxxx' are a different name
      // than '\0/tmp/dbus-xxxx\0\0\0...'. The length of the address structure
      // passed to connect() etc. tells those calls how many bytes of the name
      // to look at. Therefore, when computing the length of the address in
      // this case, any trailing null bytes are trimmed.
      // TODO(dart:io): Support abstract UNIX socket addresses that have
      // trailing null bytes on purpose.
      // https://github.com/dart-lang/sdk/issues/46158
      intptr_t nulls = 0;
      if (!unnamed_unix_socket && addr.un.sun_path[0] == '\0') {
        intptr_t i = sizeof(addr.un.sun_path) - 1;
        while (addr.un.sun_path[i] == '\0') {
          nulls++;
          i--;
        }
      }
      return sizeof(struct sockaddr_un) - nulls;
    }
    default:
      UNREACHABLE();
      return 0;
  }
}

GetAddrPort()

intptr_t dart::bin::SocketAddress::GetAddrPort ( const RawAddr &  addr )

static

Definition at line 187 of file socket_base.cc.

                                                       {
  if (addr.ss.ss_family == AF_INET) {
    return ntohs(addr.in.sin_port);
  } else if (addr.ss.ss_family == AF_INET6) {
    return ntohs(addr.in6.sin6_port);
  } else if (addr.ss.ss_family == AF_UNIX) {
    return 0;
  } else {
    UNREACHABLE();
    return -1;
  }
}

GetAddrScope()

intptr_t dart::bin::SocketAddress::GetAddrScope ( const RawAddr &  addr )

static

Definition at line 237 of file socket_base.cc.

                                                        {
  if (addr.addr.sa_family == AF_INET6) {
    return addr.in6.sin6_scope_id;
  } else {
    return 0;
  }
}

GetInAddrLength()

intptr_t dart::bin::SocketAddress::GetInAddrLength ( const RawAddr &  addr )

static

Definition at line 74 of file socket_base.cc.

                                                           {
  ASSERT((addr.ss.ss_family == AF_INET) || (addr.ss.ss_family == AF_INET6));
  return (addr.ss.ss_family == AF_INET6) ? sizeof(struct in6_addr)
                                         : sizeof(struct in_addr);
}

GetSockAddr()

void dart::bin::SocketAddress::GetSockAddr ( Dart_Handle  obj, RawAddr *  addr  )

static

Definition at line 105 of file socket_base.cc.

                                                              {
  Dart_TypedData_Type data_type;
  uint8_t* data = nullptr;
  intptr_t len;
  Dart_Handle result = Dart_TypedDataAcquireData(
      obj, &data_type, reinterpret_cast<void**>(&data), &len);
  if (Dart_IsError(result)) {
    Dart_PropagateError(result);
  }
  if ((data_type != Dart_TypedData_kUint8) ||
      ((len != sizeof(in_addr)) && (len != sizeof(in6_addr)))) {
    Dart_PropagateError(Dart_NewApiError("Unexpected type for socket address"));
  }
  memset(reinterpret_cast<void*>(addr), 0, sizeof(RawAddr));
  if (len == sizeof(in_addr)) {
    addr->in.sin_family = AF_INET;
    memmove(reinterpret_cast<void*>(&addr->in.sin_addr), data, len);
  } else {
    ASSERT(len == sizeof(in6_addr));
    addr->in6.sin6_family = AF_INET6;
    memmove(reinterpret_cast<void*>(&addr->in6.sin6_addr), data, len);
  }
  Dart_TypedDataReleaseData(obj);
}

GetType()

int dart::bin::SocketAddress::GetType

(

)

Definition at line 25 of file socket_base.cc.

                           {
  switch (addr_.ss.ss_family) {
    case AF_INET6:
      return TYPE_IPV6;
    case AF_INET:
      return TYPE_IPV4;
    case AF_UNIX:
      return TYPE_UNIX;
    default:
      UNREACHABLE();
      return TYPE_ANY;
  }
}

GetUnixDomainSockAddr()

Dart_Handle dart::bin::SocketAddress::GetUnixDomainSockAddr ( const char *  path, Namespace *  namespc, RawAddr *  addr  )

static

Definition at line 130 of file socket_base.cc.

                                                                {
#if defined(DART_HOST_OS_LINUX) || defined(DART_HOST_OS_ANDROID)
  NamespaceScope ns(namespc, path);
  path = ns.path();
  bool is_abstract = (path[0] == '@');
  if (is_abstract) {
    // The following 107 bytes after the leading null byte represents the name
    // of unix domain socket. Without reseting, even users provide the same path
    // for bind and connect, they actually represent two different address and
    // connection will be rejected.
    bzero(addr->un.sun_path, sizeof(addr->un.sun_path));
  }
#endif  // defined(DART_HOST_OS_LINUX) || defined(DART_HOST_OS_ANDROID)
  if (sizeof(path) > sizeof(addr->un.sun_path)) {
    OSError os_error(-1,
                     "The length of path exceeds the limit. "
                     "Check out man 7 unix page",
                     OSError::kUnknown);
    return DartUtils::NewDartOSError(&os_error);
  }
  addr->un.sun_family = AF_UNIX;
  Utils::SNPrint(addr->un.sun_path, sizeof(addr->un.sun_path), "%s", path);
#if defined(DART_HOST_OS_LINUX) || defined(DART_HOST_OS_ANDROID)
  // In case of abstract namespace, transfer the leading '@' into a null byte.
  if (is_abstract) {
    addr->un.sun_path[0] = '\0';
  }
#endif  // defined(DART_HOST_OS_LINUX) || defined(DART_HOST_OS_ANDROID)
  return Dart_Null();
}

SetAddrPort()

void dart::bin::SocketAddress::SetAddrPort ( RawAddr *  addr, intptr_t  port  )

static

Definition at line 177 of file socket_base.cc.

                                                            {
  if (addr->ss.ss_family == AF_INET) {
    addr->in.sin_port = htons(port);
  } else if (addr->ss.ss_family == AF_INET6) {
    addr->in6.sin6_port = htons(port);
  } else {
    UNREACHABLE();
  }
}

SetAddrScope()

void dart::bin::SocketAddress::SetAddrScope ( RawAddr *  addr, intptr_t  scope_id  )

static

Definition at line 232 of file socket_base.cc.

                                                                 {
  if (addr->addr.sa_family != AF_INET6) return;
  addr->in6.sin6_scope_id = scope_id;
}

ToCObject()

CObjectUint8Array * dart::bin::SocketAddress::ToCObject ( const RawAddr &  addr )

static

Definition at line 220 of file socket_base.cc.

                                                               {
  int in_addr_len = SocketAddress::GetInAddrLength(addr);
  const void* in_addr;
  if (addr.addr.sa_family == AF_INET6) {
    in_addr = reinterpret_cast<const void*>(&addr.in6.sin6_addr);
  } else {
    in_addr = reinterpret_cast<const void*>(&addr.in.sin_addr);
  }
  CObjectUint8Array* data =
      new CObjectUint8Array(CObject::NewUint8Array(in_addr, in_addr_len));
  return data;
}

ToTypedData()

Dart_Handle dart::bin::SocketAddress::ToTypedData ( const RawAddr &  addr )

static

Definition at line 200 of file socket_base.cc.

                                                          {
  int len = GetInAddrLength(addr);
  Dart_Handle result = Dart_NewTypedData(Dart_TypedData_kUint8, len);
  if (Dart_IsError(result)) {
    Dart_PropagateError(result);
  }
  Dart_Handle err;
  if (addr.addr.sa_family == AF_INET6) {
    err = Dart_ListSetAsBytes(
        result, 0, reinterpret_cast<const uint8_t*>(&addr.in6.sin6_addr), len);
  } else {
    err = Dart_ListSetAsBytes(
        result, 0, reinterpret_cast<const uint8_t*>(&addr.in.sin_addr), len);
  }
  if (Dart_IsError(err)) {
    Dart_PropagateError(err);
  }
  return result;
}

---

The documentation for this class was generated from the following files:

• third_party/dart-lang/sdk/runtime/bin/socket_base.h
• third_party/dart-lang/sdk/runtime/bin/socket_base.cc