Menu
Search

API Documentation

version 2.083.0

overview

View source code
Display the source code in std/socket.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Class std.socket.UnixAddress

UnixAddress encapsulates an address for a Unix domain socket (AF_UNIX), i.e. a socket bound to a path name in the file system. Available only on supported systems.

class UnixAddress
  : Address ;
class UnixAddress
  : Address ;

Linux also supports an abstract address namespace, in which addresses are independent of the file system. A socket address is abstract iff path starts with a null byte ('\0'). Null bytes in other positions of an abstract address are allowed and have no special meaning.

Constructors

NameDescription
this Construct a new UnixAddress from the specified path.
this Construct a new UnixAddress.

Properties

NameTypeDescription
path[get] stringGet the underlying path.
addressFamily[get] AddressFamilyFamily of this address.
name[get] core.sys.posix.sys.socket.sockaddr*Returns pointer to underlying sockaddr structure.
nameLen[get] uintReturns actual size of underlying sockaddr structure.

Methods

NameDescription
toString Get the underlying path.
factory Create instance of class specified by the fully qualified name classname. The class must either have no constructors or have a default constructor.
opCmp Compare with another Object obj.
opEquals Test whether this is equal to o. The default implementation only compares by identity (using the is operator). Generally, overrides for opEquals should attempt to compare objects by their contents.
toAddrString Attempts to retrieve the host address as a human-readable string.
toHash Compute hash function for Object.
toHostNameString Attempts to retrieve the host name as a fully qualified domain name.
toPortString Attempts to retrieve the numeric port number as a string.
toServiceNameString Attempts to retrieve the service name as a string.
toString Convert Object to a human readable string.

Constructors

NameDescription
this Construct a new UnixAddress from the specified path.
this Construct a new UnixAddress.

Properties

NameTypeDescription
path[get] stringGet the underlying path.
addressFamily[get] AddressFamilyFamily of this address.
name[get] core.sys.posix.sys.socket.sockaddr*Returns pointer to underlying sockaddr structure.
nameLen[get] uintReturns actual size of underlying sockaddr structure.

Methods

NameDescription
toString Get the underlying path.
factory Create instance of class specified by the fully qualified name classname. The class must either have no constructors or have a default constructor.
opCmp Compare with another Object obj.
opEquals Test whether this is equal to o. The default implementation only compares by identity (using the is operator). Generally, overrides for opEquals should attempt to compare objects by their contents.
toAddrString Attempts to retrieve the host address as a human-readable string.
toHash Compute hash function for Object.
toHostNameString Attempts to retrieve the host name as a fully qualified domain name.
toPortString Attempts to retrieve the numeric port number as a string.
toServiceNameString Attempts to retrieve the service name as a string.
toString Convert Object to a human readable string.

Example

auto addr = new UnixAddress("/var/run/dbus/system_bus_socket");
auto abstractAddr = new UnixAddress("\0/tmp/dbus-OtHLWmCLPR");

See Also

UNIX(7)

Authors

Christopher E. Miller, David Nadlinger, Vladimir Panteleev

License

Boost License 1.0.