set_socket_option() [2/5]

void xtd::net::sockets::socket::set_socket_option	(	xtd::net::sockets::socket_option_level	socket_option_level,
		xtd::net::sockets::socket_option_name	socket_option_name,
		int32	option_value
	)

Sets the specified xtd::net::sockets::socket option to the specified integer value.

Parameters

socket_option_level	One of the xtd::net::sockets::socket_option_level values.
socket_option_name	One of the xtd::net::sockets::socket_option_name values.
option_value	A value of the option.

Exceptions

xtd::net::sockets::socket_exception	An error occurred when attempting to access the socket.
xtd::object_closed_exception	The xtd::net::sockets::socket has been closed.

Remarks

xtd::net::sockets::socket options determine the behavior of the current xtd::net::sockets::socket. For an option with a bool data type, specify a nonzero value to enable the option, and a zero value to disable the option. For an option with an int data type, specify the appropriate value. xtd::net::sockets::socket options are grouped by level of protocol support.

Listed below are the various xtd::net::sockets::socket options that can be set using this overload. These options are grouped by the appropriate xtd::net::sockets::socket_option_level. If you intend to set any of these options, be sure to use the appropriate xtd::net::sockets::socket_option_level for the optionLevel parameter. The option you choose to set must be specified in the option_ame parameter. If you want to get the current value of any of the options listed, use the xtd::net::sockets::socket::get_socket_option method.

• xtd::net::sockets::socket_option_level::socket options that can be set using this overload:
  • xtd::net::sockets::socket_option_name::broadcast
  • xtd::net::sockets::socket_option_name::dont_linger
  • xtd::net::sockets::socket_option_name::debug
  • xtd::net::sockets::socket_option_name::error
  • xtd::net::sockets::socket_option_name::keep_alive
  • xtd::net::sockets::socket_option_name::out_of_band_inline
  • xtd::net::sockets::socket_option_name::receive_buffer
  • xtd::net::sockets::socket_option_name::receive_timeout
  • xtd::net::sockets::socket_option_name::reuse_address
  • xtd::net::sockets::socket_option_name::send_buffer
  • xtd::net::sockets::socket_option_name::send_timeout
  • xtd::net::sockets::socket_option_name::type
• xtd::net::sockets::socket_option_level::ip options that can be set using this overload:
  • xtd::net::sockets::socket_option_name::header_included
  • xtd::net::sockets::socket_option_name::ip_options
  • xtd::net::sockets::socket_option_name::ip_time_to_live
  • xtd::net::sockets::socket_option_name::multicast_interface
  • xtd::net::sockets::socket_option_name::multicast_loopback
  • xtd::net::sockets::socket_option_name::multicast_time_to_live
  • xtd::net::sockets::socket_option_name::use_loopback
• xtd::net::sockets::socket_option_level::tcp options that can be set using this overload:
  • xtd::net::sockets::socket_option_name::bsd_urgent
  • xtd::net::sockets::socket_option_name::expedited
  • xtd::net::sockets::socket_option_name::no_delay
• xtd::net::sockets::socket_option_level::udp options that can be set using this overload:
  • xtd::net::sockets::socket_option_name::checksum_coverage
  • xtd::net::sockets::socket_option_name::no_checksum
• xtd::net::sockets::socket_option_level::ip_v6 options that can be set using this overload:
  • xtd::net::sockets::socket_option_name::hop_limit

For more information on these options, refer to the xtd::net::sockets::socket_option_name enumeration.

Note

If you receive a xtd::net::sockets::socket_exception exception, use the xtd::net::sockets::socket_exception::error_code property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation in the MSDN library for a detailed description of the error.