[#CSubNet]
= CSubNet
:mrdocs:

A subnet: a network base address together with a netmask.

== Synopsis

Declared in `<netaddress.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:CSubNet/2constructor-02ef.adoc[`CSubNet`]         [.small]#[constructor]#
| Constructors
| xref:CSubNet/IsValid.adoc[`IsValid`] 
| Whether this subnet was parsed/constructed successfully.
| xref:CSubNet/Match.adoc[`Match`] 
| Whether the given address falls within this subnet.
| xref:CSubNet/ToString.adoc[`ToString`] 
| Get a human‐readable CIDR representation of this subnet.
|===


== Protected Data Members

[cols="1,4"]
|===
| Name| Description
| xref:CSubNet/netmask.adoc[`netmask`] 
| Netmask, in network byte order
| xref:CSubNet/network.adoc[`network`] 
| Network (base) address
| xref:CSubNet/valid.adoc[`valid`] 
| Is this value valid? (only used to signal parse errors)
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:operator_lt-078.adoc[operator<]`
| Order two subnets.
| `xref:operator_eq-09.adoc[operator==]`
| Compare two subnets for equality.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:LookupSubNet.adoc[`LookupSubNet`]
| Parse and resolve a specified subnet string into the appropriate internal representation.
|===


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