| Home | Libraries | People | FAQ | More

# Boolean_Socket_Option Class Reference

Inherits Socket_Option.

Inheritance diagram for Boolean_Socket_Option:

List of all members.

## Detailed Description

Boolean_Socket_Option concept.

Implemented By:
  boost::asio::socket_base::broadcast
  boost::asio::socket_base::do_not_route
  boost::asio::socket_base::keep_alive
  boost::asio::socket_base::reuse_address
  boost::asio::ipv4::tcp::no_delay
  boost::asio::ipv4::multicast::enable_loopback

## Public Member Functions

| Boolean_Socket_Option ()
| Default constructor initialises contained value to 0.
| Boolean_Socket_Option (bool value)
| Construct with a specific option value.
void | set (bool value)
| Set the value of the boolean option.
bool | get () const
| Get the current value of the boolean option.
template<typename Protocol>
int | level (const Protocol &protocol) const
| Get the level of the socket option.
template<typename Protocol>
int | name (const Protocol &protocol) const
| Get the name of the socket option.
template<typename Protocol>
implementation_defined | data (const Protocol &protocol)
| Get a pointer to the socket option data.
template<typename Protocol>
implementation_defined | data (const Protocol &protocol) const
| Get a pointer to the socket option data.
template<typename Protocol>
std::size_t | size (const Protocol &protocol) const
| Get the size of the socket option data in bytes.

## Constructor & Destructor Documentation

Boolean_Socket_Option::Boolean_Socket_Option | ( |  | ) |

Default constructor initialises contained value to 0.

Boolean_Socket_Option::Boolean_Socket_Option | ( | bool | value | ) |

Construct with a specific option value.

## Member Function Documentation

void Boolean_Socket_Option::set | ( | bool | value | ) |

Set the value of the boolean option.

bool Boolean_Socket_Option::get | ( |  | ) | const

Get the current value of the boolean option.

template<typename Protocol>

int Socket_Option::level | ( | const Protocol & | protocol | ) | const`[inherited]`

Get the level of the socket option.

template<typename Protocol>

int Socket_Option::name | ( | const Protocol & | protocol | ) | const`[inherited]`

Get the name of the socket option.

template<typename Protocol>

implementation_defined Socket_Option::data | ( | const Protocol & | protocol | ) | `[inherited]`

Get a pointer to the socket option data.

template<typename Protocol>

implementation_defined Socket_Option::data | ( | const Protocol & | protocol | ) | const`[inherited]`

Get a pointer to the socket option data.

template<typename Protocol>

std::size_t Socket_Option::size | ( | const Protocol & | protocol | ) | const`[inherited]`

Get the size of the socket option data in bytes.

| Copyright © 2003 - 2006 Christopher M. Kohlhoff