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

Inherits xtd::object.

Public Member Functions
	ip_packet_information ()=default
	Creates an empty xtd::net::sockets::ip_packet_information instance.
const xtd::net::ip_address &	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.
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.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.
virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.

Additional Inherited Members
Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal.
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.

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:

• xtd.core/include/xtd/net/sockets/ip_packet_information.h