[#boost-urls-ipv4_address]
= xref:boost/urls/ipv4_address.adoc[boost::urls::ipv4_address]
:relfileprefix: ../../
:mrdocs:

An IP version 4 style address.

== Synopsis

Declared in `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/ipv4_address.hpp#L53[boost/url/ipv4_address.hpp]>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class ipv4_address;
----

== Types

[cols=2]
|===
| Name
| Description
| xref:boost/urls/ipv4_address/bytes_type.adoc[`bytes_type`] 
| The type used to represent an address as an array of bytes
| xref:boost/urls/ipv4_address/uint_type.adoc[`uint_type`] 
| The type used to represent an address as an unsigned integer
|===

== Member Functions

[cols=2]
|===
| Name
| Description
| xref:boost/urls/ipv4_address/2constructor-00.adoc[`ipv4_address`]         [.small]#[constructor]#
| Constructors
| xref:boost/urls/ipv4_address/operator_assign.adoc[`operator=`] 
| Copy Assignment.
| xref:boost/urls/ipv4_address/is_loopback.adoc[`is_loopback`] 
| Return true if the address is a loopback address
| xref:boost/urls/ipv4_address/is_multicast.adoc[`is_multicast`] 
| Return true if the address is a multicast address
| xref:boost/urls/ipv4_address/is_unspecified.adoc[`is_unspecified`] 
| Return true if the address is unspecified
| xref:boost/urls/ipv4_address/to_buffer.adoc[`to_buffer`] 
| Write a dotted decimal string representing the address to a buffer
| xref:boost/urls/ipv4_address/to_bytes.adoc[`to_bytes`] 
| Return the address as bytes, in network byte order.
| xref:boost/urls/ipv4_address/to_string.adoc[`to_string`] 
| Return the address as a string in dotted decimal format
| xref:boost/urls/ipv4_address/to_uint.adoc[`to_uint`] 
| Return the address as an unsigned integer.
|===

== Static Member Functions

[cols=2]
|===
| Name
| Description
| xref:boost/urls/ipv4_address/any.adoc[`any`] 
| Return an address object that represents any address
| xref:boost/urls/ipv4_address/broadcast.adoc[`broadcast`] 
| Return an address object that represents the broadcast address
| xref:boost/urls/ipv4_address/loopback.adoc[`loopback`] 
| Return an address object that represents the loopback address
|===

== Static Data Members

[cols=2]
|===
| Name
| Description
| xref:boost/urls/ipv4_address/max_str_len.adoc[`max_str_len`] 
| The number of characters in the longest possible IPv4 string.
|===

== Friends

[cols=2]
|===
| Name
| Description
| `xref:boost/urls/ipv6_address.adoc[boost::urls::ipv6_address]`
| An IP version 6 style address.
| `xref:boost/urls/operator_lshift-0a.adoc[boost::urls::operator<<]`
| Format the address to an output stream.
| `xref:boost/urls/operator_not_eq-02.adoc[boost::urls::operator!=]`
| Return true if two addresses are not equal
| `xref:boost/urls/operator_eq-0f2.adoc[boost::urls::operator==]`
| Return true if two addresses are equal
| `xref:boost/urls/ipv6_address.adoc[boost::urls::ipv6_address]`
| An IP version 6 style address.
| `xref:boost/urls/operator_lshift-0a.adoc[boost::urls::operator<<]`
| Format the address to an output stream.
| `xref:boost/urls/operator_not_eq-02.adoc[boost::urls::operator!=]`
| Return true if two addresses are not equal
| `xref:boost/urls/operator_eq-0f2.adoc[boost::urls::operator==]`
| Return true if two addresses are equal
|===

== Non-Member Functions

[cols=2]
|===
| Name
| Description
| xref:boost/urls/parse_ipv4_address.adoc[`parse_ipv4_address`]
| Return an IPv4 address from an IP address string in dotted decimal form
|===

== Description

Objects of this type are used to construct, parse, and manipulate IP version 6 addresses.

== BNF
[,cpp]
----
IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet

dec-octet   = DIGIT                 ; 0-9
            / %x31-39 DIGIT         ; 10-99
            / "1" 2DIGIT            ; 100-199
            / "2" %x30-34 DIGIT     ; 200-249
            / "25" %x30-35          ; 250-255
----
== Specification
* https://en.wikipedia.org/wiki/IPv4[]
* https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2[]

== See Also

xref:boost/urls/parse_ipv4_address.adoc[`parse_ipv4_address`], xref:boost/urls/ipv6_address.adoc[`ipv6_address`].


[.small]#Created with https://www.mrdocs.com[MrDocs]#