[#MappingResult]
= MappingResult
:mrdocs:

Successful response to a port mapping.

== Synopsis

Declared in `<common/pcp.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct MappingResult;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:MappingResult/2constructor.adoc[`MappingResult`]         [.small]#[constructor]#
| Construct a successful mapping result.
| xref:MappingResult/ToString.adoc[`ToString`] 
| Format mapping as string for logging.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:MappingResult/external.adoc[`external`] 
| External host:port.
| xref:MappingResult/lifetime.adoc[`lifetime`] 
| Granted lifetime of binding (seconds).
| xref:MappingResult/version.adoc[`version`] 
| Protocol version, one of NATPMP_VERSION or PCP_VERSION.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:NATPMPRequestPortMap.adoc[`NATPMPRequestPortMap`]
| Try to open a port using RFC 6886 NAT‐PMP. IPv4 only.
| xref:PCPRequestPortMap.adoc[`PCPRequestPortMap`]
| Try to open a port using RFC 6887 Port Control Protocol (PCP). Handles IPv4 and IPv6.
|===


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