Handy-Http
/
primitives
1
1
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Added documentation to address module.

This commit is contained in:
Andrew Lalis 2024-10-30 08:08:43 -04:00
parent a5a3774d69
commit 9a4c4a46f6
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
source/handy_http_primitives/address.d
View File

@ -3,6 +3,10 @@
*/ */
module handy_http_primitives.address; module handy_http_primitives.address;
/**
* Represents a 4-byte IPv4 network address and the port number on this machine
* that the connection was assigned to.
*/
struct IPv4InternetAddress { struct IPv4InternetAddress {
const ubyte[4] bytes; const ubyte[4] bytes;
const ushort port; const ushort port;
@ -20,6 +24,10 @@ struct IPv4InternetAddress {
} }
} }
/**
* Represents a 16-byte IPv6 network address and the port number on this
* machine that the connection was assigned to.
*/
struct IPv6InternetAddress { struct IPv6InternetAddress {
const ubyte[16] bytes; const ubyte[16] bytes;
const ushort port; const ushort port;
@ -29,6 +37,10 @@ struct IPv6InternetAddress {
} }
} }
/**
* Represents a unix socket address, which is just a path to a file at which
* IO operations take place.
*/
struct UnixSocketAddress { struct UnixSocketAddress {
const string path; const string path;
@ -37,12 +49,17 @@ struct UnixSocketAddress {
} }
} }
/// Defines the different possible address types, used by `ClientAddress`.
enum ClientAddressType { enum ClientAddressType {
IPv4, IPv4,
IPv6, IPv6,
UNIX UNIX
} }
/**
* A compound type representing the address of any entity sending an HTTP
* request. Use `type` to determine which information is available.
*/
struct ClientAddress { struct ClientAddress {
const ClientAddressType type; const ClientAddressType type;
const IPv4InternetAddress ipv4InternetAddress; const IPv4InternetAddress ipv4InternetAddress;