xtd - Reference Guide  0.1.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Public Member Functions | List of all members
xtd::net::sockets::ip_packet_information Class Reference

#include <ip_packet_information.h>

Definition

Gets the network interface information that is associated with a call to xtd::net::sockets::socket::receive_message_from or xtd::net::sockets::socket::end_receive_message_from.

Namespace
xtd::net::sockets
Library
xtd.core

Public Member Functions

 ip_packet_information ()=default
 Creates an empty xtd::net::sockets::ip_packet_information instance. More...
 
const xtd::net::ip_addressaddress () const noexcept
 Gets the origin information of the packet that was received as a result of calling the xtd::net::sockets::socket::receive_message_from method or xtd::net::sockets::socket::end_receive_message_from method. More...
 
int32_t interface () const noexcept
 Gets the network interface information that is associated with a call to xtd::net::sockets::socket::receive_message_from method or xtd::net::sockets::socket::end_receive_message_from. More...
 

Constructor & Destructor Documentation

◆ ip_packet_information()

xtd::net::sockets::ip_packet_information::ip_packet_information ( )
default

Creates an empty xtd::net::sockets::ip_packet_information instance.

Member Function Documentation

◆ address()

const xtd::net::ip_address& xtd::net::sockets::ip_packet_information::address ( ) const
noexcept

Gets the origin information of the packet that was received as a result of calling the xtd::net::sockets::socket::receive_message_from method or xtd::net::sockets::socket::end_receive_message_from method.

Returns
An xtd::net::ip_address that indicates the origin information of the packet that was received as a result of calling the xtd::net::sockets::socket::receive_message_from method or xtd::net::sockets::socket::end_receive_message_from method. For packets that were sent from a unicast address, the xtd::net::sockets::ip_packet_information::address property will return the xtd::net::ip_address of the sender; for multicast or broadcast packets, the xtd::net::sockets::ip_packet_information::address property will return the multicast or broadcast xtd::net::ip_address.

◆ interface()

int32_t xtd::net::sockets::ip_packet_information::interface ( ) const
noexcept

Gets the network interface information that is associated with a call to xtd::net::sockets::socket::receive_message_from method or xtd::net::sockets::socket::end_receive_message_from.

Returns
An int32_t value, which represents the index of the network interface. You can use this index with xtd::net::network_information::network_interface::get_all_network_interfaces() to get more information about the relevant interface.

The documentation for this class was generated from the following file: