xtd::net::sockets::ip_v6_multicast_option Class Reference

Inheritance diagram for xtd::net::sockets::ip_v6_multicast_option:

Definition

Contains option values for joining an IPv6 multicast group.

class core_export_ ip_v6_multicast_option : public xtd::object, public xtd::iequatable<xtd::net::sockets::ip_v6_multicast_option>;

Inheritance

xtd::object → xtd::net::sockets::ip_v6_multicast_option

Header

#include <xtd/net/sockets/ip_v6_multicast_option>

Namespace

xtd::net::sockets

Library

xtd.core

Public Constructors
	ip_v6_multicast_option ()=default
	Initializes a new instance of the xtd::net::sockets::ip_v6_multicast_option class.
	ip_v6_multicast_option (const xtd::net::ip_address &group)
	Initializes a new version of the xtd::net::sockets::ip_v6_multicast_option class for the specified IP multicast group.
	ip_v6_multicast_option (const xtd::net::ip_address &group, uint64 interface_index)
	Initializes a new instance of the xtd::net::sockets::ip_v6_multicast_option class with the specified IP multicast group and the local interface address.

Public Properties
const xtd::net::ip_address &	group () const noexcept
	Gets the IP address of a multicast group.
ip_v6_multicast_option &	group (const xtd::net::ip_address &value) noexcept
	Sets the IP address of a multicast group.
uint64	interface_index () const noexcept
	Gets the interface index that is associated with a multicast group.
ip_v6_multicast_option &	interface_index (uint64 value)
	Sets the interface index that is associated with a multicast group.

Public Methods
bool	equals (const object &obj) const noexcept override
	Determines whether the specified object is equal to the current object.
bool	equals (const ip_v6_multicast_option &other) const noexcept override
	Determines whether the specified object is equal to the current object.
xtd::size	get_hash_code () const noexcept override
	Serves as a hash function for a particular type.

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.
Public Member Functions inherited from xtd::iequatable< xtd::net::sockets::ip_v6_multicast_option >
Static Public Member Functions inherited from xtd::object
template<class object_a_t , class object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<class object_a_t , class object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

ip_v6_multicast_option() [1/3]

xtd::net::sockets::ip_v6_multicast_option::ip_v6_multicast_option ( )

default

Initializes a new instance of the xtd::net::sockets::ip_v6_multicast_option class.

ip_v6_multicast_option() [2/3]

xtd::net::sockets::ip_v6_multicast_option::ip_v6_multicast_option ( const xtd::net::ip_address &  group )

explicit

Initializes a new version of the xtd::net::sockets::ip_v6_multicast_option class for the specified IP multicast group.

Parameters

group

The xtd::net::ip_address of the multicast group.

ip_v6_multicast_option() [3/3]

xtd::net::sockets::ip_v6_multicast_option::ip_v6_multicast_option	(	const xtd::net::ip_address &	group,
		uint64	interface_index
	)

Initializes a new instance of the xtd::net::sockets::ip_v6_multicast_option class with the specified IP multicast group and the local interface address.

Parameters

group	The xtd::net::ip_address of the multicast group.
interface_index	The address of the interface.

Member Function Documentation

group() [1/2]

const xtd::net::ip_address & xtd::net::sockets::ip_v6_multicast_option::group ( ) const

noexcept

Gets the IP address of a multicast group.

Returns

An xtd::net::ip_address that contains the Internet address of a multicast group.

group() [2/2]

ip_v6_multicast_option & xtd::net::sockets::ip_v6_multicast_option::group ( const xtd::net::ip_address &  value )

noexcept

Sets the IP address of a multicast group.

Parameters

value

An xtd::net::ip_address that contains the Internet address of a multicast group.

Returns

the current instance.

interface_index() [1/2]

uint64 xtd::net::sockets::ip_v6_multicast_option::interface_index ( ) const

noexcept

Gets the interface index that is associated with a multicast group.

Returns

A uint64 value that specifies the address of the interface.

Remarks

This property specifies the interface on which data is received or sent.

interface_index() [2/2]

ip_v6_multicast_option & xtd::net::sockets::ip_v6_multicast_option::interface_index

(

uint64

value

)

Sets the interface index that is associated with a multicast group.

Parameters

value

A uint64 value that specifies the address of the interface.

Returns

the current instance.

Exceptions

xtd::argument_out_of_range_exception

value > 0x00000000FFFFFFFF.

Remarks

This property specifies the interface on which data is received or sent.

equals() [1/2]

bool xtd::net::sockets::ip_v6_multicast_option::equals ( const object &  obj ) const

overridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

Reimplemented from xtd::object.

equals() [2/2]

bool xtd::net::sockets::ip_v6_multicast_option::equals ( const ip_v6_multicast_option &  other ) const

overridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

other

The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

Implements xtd::iequatable< xtd::net::sockets::ip_v6_multicast_option >.

get_hash_code()

xtd::size xtd::net::sockets::ip_v6_multicast_option::get_hash_code ( ) const

overridevirtualnoexcept

Serves as a hash function for a particular type.

Returns

A hash code for the current object.

Reimplemented from xtd::object.

---

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

• xtd.core/include/xtd/net/sockets/ip_v6_multicast_option.hpp