xtd 0.2.0
Loading...
Searching...
No Matches
xtd::net::sockets::ip_v6_multicast_option Class Reference
Inheritance diagram for xtd::net::sockets::ip_v6_multicast_option:
xtd::object

Definition

Contains option values for joining an IPv6 multicast group.

Contains option values for joining an IPv6 multicast group.
Definition ip_v6_multicast_option.h:32
Supports all classes in the xtd class hierarchy and provides low-level services to derived classes....
Definition object.h:42
#define core_export_
Define shared library export.
Definition core_export.h:13
Inheritance
xtd::objectxtd::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, uint32 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_addressgroup () const noexcept
 Gets the IP address of a multicast group.
 
ip_v6_multicast_optiongroup (const xtd::net::ip_address &value) noexcept
 Sets the IP address of a multicast group.
 
uint32 interface_index () const noexcept
 Gets the interface index that is associated with a multicast group.
 
ip_v6_multicast_optioninterface_index (uint32 value) noexcept
 Sets the interface index that is associated with a multicast group.
 

Additional Inherited Members

- 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.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename 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.
 
- Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename 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<typename object_a_t , typename 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
groupThe 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,
uint32  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
groupThe xtd::net::ip_address of the multicast group.
interface_indexThe 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
valueAn xtd::net::ip_address that contains the Internet address of a multicast group.
Returns
the current instance.

◆ interface_index() [1/2]

uint32 xtd::net::sockets::ip_v6_multicast_option::interface_index ( ) const
noexcept

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

Returns
A uint32 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 ( uint32  value)
noexcept

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

Parameters
valueA uint32 value that specifies the address of the interface.
Returns
the current instance.
Remarks
This property specifies the interface on which data is received or sent.

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