boost::urls::ipv4_address :: Boost Libraries Documentation

# boost::urls::ipv4_address

An IP version 4 style address.

## Synopsis

Declared in `<boost/url/ipv4_address.hpp>`

    class ipv4_address;

## Description

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

## BNF

    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

- IPv4 (Wikipedia)

- 3.2.2. Host (rfc3986)

## Type Aliases

Name | Description
`bytes_type` | The type used to represent an address as an array of bytes
`uint_type` | The type used to represent an address as an unsigned integer

## Member Functions

Name | Description
`ipv4_address` [constructor] | Constructors
`operator=` | Copy Assignment.
`is_loopback` | Return true if the address is a loopback address
`is_multicast` | Return true if the address is a multicast address
`is_unspecified` | Return true if the address is unspecified
`to_buffer` | Write a dotted decimal string representing the address to a buffer
`to_bytes` | Return the address as bytes, in network byte order.
`to_string` | Return the address as a string in dotted decimal format
`to_uint` | Return the address as an unsigned integer.

## Static Member Functions

Name | Description
`any` | Return an address object that represents any address
`broadcast` | Return an address object that represents the broadcast address
`loopback` | Return an address object that represents the loopback address

## Static Data Members

Name | Description
`max_str_len` | The number of characters in the longest possible IPv4 string.

## Friends

Name | Description
`boost::urls::ipv6_address` | An IP version 6 style address.
`boost::urls::operator<<` | Format the address to an output stream.
`boost::urls::operator!=` | Return true if two addresses are not equal
`boost::urls::operator==` | Return true if two addresses are equal

## Non-Member Functions

Name | Description
`parse_ipv4_address` | Return an IPv4 address from an IP address string in dotted decimal form

## See Also

`parse_ipv4_address`, `ipv6_address`.

Created with MrDocs